mirror of https://github.com/ClementTsang/bottom synced 2024-11-23 20:53:07 +00:00

* docs: add separate section on development

* docs: update instructions on writing docs

* docs: add build and deploy docs

2022-09-12 04:14:19 -04:00

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

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

Fork the repository first and make changes there.
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.

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 MkDocs, Material for MkDocs, mdx_truly_sane_lists, and optionally Mike installed to provide live reloading and preview for your changes. They aren't needed but it'll help with validating your changes.

You can do so through pip or your system's package managers. If you use pip, you probably would want to do something like so through a venv:
```
# Starting from the repo root:
cd docs/

# Create venv and activate
python -m venv venv
source venv/bin/activate

# Install requirements
pip install -r requirements.txt

# Run mkdocs
venv/bin/mkdocs serve
```
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.