1. Go to the docs/ directory and create a markdown file in the most appropriate place or modify an existing one.

2. Make sure your file is included in mkdocs.yml in the nav: section. Give it a proper name.

3. If you're creating or updating architecture or sequence diagrams in the docs, use a tool called mermaid.js for this. You can use their live editor to create a text file. The text file must start and end with an empty line and must be stored in diagrams directory. After your diagram is properly designed, generate an image in the repository using the helper script. Run in from the repo root. Example:

$ python docs/diagram_generator.py docs/diagrams/updating-docs-algorithm.txt

The diagram will appear in the images subdirectory. Link the image in your document.

1. Run mkdocs serve in the repo root directory and make sure your document renders properly:

   • To install: pip install -r requirements.txt.
   • The default address is localhost:8000. Use mkdocs serve -a localhost:<free-port> for an alternative port.

2. Create a merge request with your changes. Once it lands on main :performing_arts:, your docs will appear here. That's it! :tada:

An algorithm summarising the procedure: