Documentation

When should documentation changes be done?

• Whenever a new feature is added, a bug is fixed, or a breaking change is made, it should be documented where appropriate (ex: README.md, changelog, etc.)
• New methods of installation are always appreciated and should be documented

What pages need documentation?

There are a few areas where documentation changes are often needed:

• The README.md
• The help menu inside of the application (located here)
• The extended documentation (here)
• The CHANGELOG.md

How should I add/update documentation?

1. Fork the repository to make changes in.

2. Where you're adding documentation will probably affect what you need to do:

   README.md or CHANGELOG.md

   For changes to README.md and CHANGELOG.md, just follow the formatting provided and use any editor.

   Generally, changes to CHANGELOG.md will be handled by a maintainer, and the contents of the file should follow the Keep a Changelog format, as well as link to the relevant PR or issues.

   Help menu

   For changes to the help menu, try to refer to the existing code within src/constants.rs on how the help menu is generated.

   Extended documentation

   For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions should be fine), MkDocs, Material for MkDocs, mdx_truly_sane_lists, and optionally Mike installed. These can help with validating your changes locally.

   You can do so through pip or your system's package managers. If you use pip, you can use venv to cleanly install the documentation dependencies:

   # Change directories to the documentation.
   cd docs/
   
    # Create venv, install the dependencies, and serve the page.
   ./serve.sh
   

   This will serve a local version of the docs that you can open on your browser. It will update as you make changes.

3. Once you have your documentation changes done, submit it as a pull request. For more information regarding that, refer to Issues, Pull Requests, and Discussions.