dsql
823aa7708a
Collapse the deploy sub-pages back into one deploy.md (tabs, not separate pages), add a working mermaid flow diagram, and rework the top per feedback. - Mermaid: enable via superfences fence_div_format (the fence_code_format <pre><code> wrapper broke mermaid's render — div format fixes it); vendor mermaid.min.js locally (no CDN dependency for a self-hosted site) + a small init that renders each block once and survives instant-nav. - Content tabs Compose / Dockerfile / Secrets hold the three pieces together on one page (inline comments in the code, no annotation +). - 'What can run here' tip moved above the flow; section renamed 'Preparing for Deploy' with the 'you don't run deploy commands' point folded sparsely into the intro (standalone note removed); 'svc never changes' called out. - Flow diagram (below the tabs): build group now includes our libraries; git -> staging shown as develop-if-gitflow (dotted); deployment (no MR-to-main) -> docker image built + run on the fleet. - Revert inbound links to deploy.md. Verified in-browser: diagram renders with all nodes, tabs switch, section order correct; 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).