Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how the entire program works, highlight and/or update existing blog post #34

Open
lmmx opened this issue Sep 8, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@lmmx
Copy link
Owner

lmmx commented Sep 8, 2024

Users are reporting that they do not understand how the software works (e.g. #17)

I am not very familiar with how the code works, but if you know how the problem may be solved, you could quickly explain to me so that I implement it and create a pull request.

This may just be that they are busy and did not have time to read an in-depth blog post.

Consider writing a more concise guide (without the technical depth of the blog post).

This should be easy given the existing reference. An LLM could write the initial draft to ensure clarity.

@lmmx lmmx added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 8, 2024
@lmmx lmmx self-assigned this Sep 8, 2024
@lmmx lmmx added this to Planner Sep 8, 2024
@lmmx lmmx moved this to 🛒 TODO in Planner Sep 8, 2024
@lmmx lmmx moved this to 🐣 Hatching in Page Dewarp Release Planner Sep 8, 2024
@lmmx lmmx moved this from 🛒 TODO to 🔙 Backlog in Planner Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: 🐣 Hatching
Status: 📚 Shelved
Development

No branches or pull requests

1 participant