dsql
350884c2b3
- 'The whole flow' is now plain prose, not an abstract box. - Restore the v2 diagram shape (git -> staging via develop-if-gitflow AND git -> deployment, converging on docker) instead of the linear main-only one, keeping the simplified 'libs (rethink-public, pip)' wording. - Spread admonition types for variety across pages: index agent-callout tip -> example; environments uv.lock note -> info; standards logging note -> info. (deploy already mixes success/danger/example/warning/tip.) Verified in-browser: whole-flow reads as text, diagram renders in the v2 shape; mkdocs build --strict clean. Signed-off-by: disqualifier <dev@disqualifier.me>
handbook
The Rethink Studios handbook — our public reference for the shared library suite, coding standards, the dev workflow, Python environments, and how to deploy on our network.
Live at docs.rethinkstudios.io.
What this is
A static documentation site built with MkDocs +
Material for MkDocs. Markdown lives
under docs/, builds to a static site/, and is served by the reverse proxy at
the subdomain — no app process, just static HTML/CSS/JS.
The Libraries page is the one dynamic part: it fetches the rethink-public
repo list from the Gitea API client-side at view time, so new libraries appear on
the next page load with no rebuild. Everything else is static markdown.
Build
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs build # -> static site/
mkdocs serve # local preview at http://127.0.0.1:8000
Contributing
- One topic per page, grouped under
docs/, wired into the nav inmkdocs.yml. - Public — sanitize: no real hostnames, internal IPs, secrets, or exact
topology. Use placeholders (
<dev>,<project>,/srv/...). - Markdown: trailing newline, no trailing whitespace, LF line endings.
- Commits signed (
git commit -s).