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

Meta: documentation improvements -- help needed #400

Open
abey79 opened this issue Feb 15, 2022 · 0 comments
Open

Meta: documentation improvements -- help needed #400

abey79 opened this issue Feb 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@abey79
Copy link
Owner

abey79 commented Feb 15, 2022

Creating, improving, and maintaining the documentation is a never-ending task which, if done consistently, greatly benefit everyone but is often not prioritised by maintainer due to lack of time, skills, motivation, or all three. Improving the documentation is also one of the easiest way to contribute to a project. This issue lists areas that may benefit from a contribution.

Easy tasks (little/no prior discussing/coordinating needed -- go ahead and open a PR):

  • fix typo and mistakes
  • improve the language (I'm not a native english speaker!)
  • fix old/broken examples in the cookbook and elsewhere
  • add new examples in the cookbook
  • cookbook recipe on how to integrate vpype in macOS automator
  • ...

Medium tasks (minor discussing/coordinating might be needed -- can be discussed in a PR but don't spend too much time before opening it)

  • add illustration for all (or most) commands examples (cookbook and elsewhere)
  • update/overhaul plug-in documentation
  • improve cookbook structure
  • break down Fundamentals (which is growing way too big) into separate top-level sections
  • add a help section about the viewer
    • screenshot
    • units
    • customising ui_scale_factor
    • etc.?
  • ...

Hard tasks (needs prior discussion before undertaking work)

  • overhaul README to give a more efficient overview of what vpype is and "quick start" guide
  • overhaul fundamentals section to give a more efficient usage overview (vs. theoretical comprehension)
  • ...
@abey79 abey79 pinned this issue Feb 15, 2022
@abey79 abey79 changed the title Meta: documentation improvements Meta: documentation improvements -- help needed Feb 15, 2022
@abey79 abey79 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 19, 2022
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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant