Contribute to the documentation¶
The portal is built from Markdown in documentation/ using Material for MkDocs. Selected API references are synchronized from Hub contracts on each build, avoiding manual copies.
Local preview¶
Use Python 3.12 from the repository root:
python -m pip install -r requirements-docs.txt
python scripts/build_docs_reference.py
python -m mkdocs serve --dev-addr 127.0.0.1:18181
Use another port if 18181 is occupied; do not stop unrelated services.
Source layout¶
| Location | Contents |
|---|---|
documentation/start |
Concepts, implementation paths, and versions |
documentation/hub |
Hub administration |
documentation/laravel |
Application integration |
documentation/reference |
APIs, configuration, and synchronized references |
documentation/help |
Security and troubleshooting |
documentation/assets |
Local logo and styles |
mkdocs.yml |
Navigation and site configuration |
The reference pages admin-api.md, connector-contract.md, tools.md, and profiles.md are generated by the synchronization script. Edit their sources in docs/, not the generated output.
Build and publication¶
The Documentation workflow validates pull requests and publishes a static artifact to GitHub Pages after changes merge into main. Only the documentation directory is built; environment files, application source, private artifacts, and evidence are not published.
Describe behavior using verified code or releases. Use example domains, distinguish package versions from the Hub server, and exclude credentials and user deployment addresses from examples. Write portal content, labels, and examples in English.