The landing page of docs.source-robotics.com: one card per product with its photo, each linking to that product's own documentation site, the latest releases of the products, and the links for help.
hooks/whats_new.py replaces the markers in docs/index.md at build time: <!-- releases --> with the latest
releases of the product repositories and <!-- updated: <docs repository> --> with the date of that site's last
commit, both read from the GitHub API. Offline or rate limited, the markers render empty. The workflow passes
GITHUB_TOKEN for the API and rebuilds the page every Monday, so the list stays fresh without a push.
Every page of every documentation site has a comments box (Giscus) whose threads are this repository's
Discussions, category Documentation, one thread per page, created when the first reader comments. Keep
Discussions enabled and the category in place; the IDs are in each site's mkdocs.yml under extra.comments.
This repository is the organisation's own GitHub Pages site, so its custom domain, docs.source-robotics.com, is
also the domain of every other documentation site in the organisation. A docs repository named par6 is served at
docs.source-robotics.com/par6/, PAROL-docs at docs.source-robotics.com/PAROL-docs/, and so on.
- Do not rename or delete this repository. Every Source Robotics docs site would move back to its github.io address.
- Renaming a docs repository changes its address, and links to the old one stop working. A redirect page can be added here under the old name.
- A new product gets a card in
docs/index.mdonce its docs repository publishes.
git clone https://github.com/Source-Robotics/source-robotics.github.io.git
cd source-robotics.github.io
python3 -m venv .venv
.venv/bin/pip install -r requirements.txt
.venv/bin/mkdocs serveOpen http://127.0.0.1:8000/. Every push to main builds the site and publishes it.
- Text and images: Creative Commons Attribution-ShareAlike 4.0, see LICENSE.
- Code: the MIT license.
- Names and logos: the Source Robotics name, the product names and the logos are not covered by either license.