dsql
17b2888c1f
Add a prominent danger admonition ('One name everywhere — repo = container =
volumes') right under the intro: the repo name is the name; the compose
service key, container_name, and every named volume must all use it. Spell
out the consequence — mismatched names break deploy, monitoring, and log
scraping, which key off the repo name.
Make the compose example teach it: rename yourapp -> myrepo throughout
(service key, container_name: myrepo, myrepo-data volume) with annotations
calling out each spot where the repo name must appear.
Verified in-browser; 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).