Contributing guide

This documentation site is maintained as docs-as-code.

Local preview

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Lightweight style rules

• Use one topic per page
• Prefer task-based headings (verbs) in tutorials
• Use admonitions for tips/warnings (!!! tip, !!! note, !!! warning)
• Keep screenshots in docs/assets/ and reference them relatively

Adding docs from another repo (imported)

To have a repository appear under Org repos in the portal:

1. Add a docs/ folder to that repository.
2. Put images under docs/assets/ and link relatively.
3. Ensure the portal mkdocs.yml has a !import entry for the repo.