dsql
5797248931
- Move the flow diagram up into 'Preparing for Deploy' (was a separate section at the bottom); drop that trailing section. - Use more admonition types for visual variety: success (what can run), abstract (the whole flow), example (container-path), success (same file both places) — alongside the existing danger/warning/tip. - Simplify the diagram: libs -> 'libs (rethink-public, pip)', the git edge -> 'branch', staging -> 'main'; abstract intro reworded to branch+main. - Trim the Compose tab: drop the rules list that duplicated the inline comments + danger box; tighten the storage tiers. Verified in-browser: diagram renders with simplified nodes near the top, six admonition types present; 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).