Skip to content

Meta: documentation improvements -- help needed #400

Open
@abey79

Description

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)
  • ...

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions