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>
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# rethink development
|
|
|
|
The reference for building and shipping on our network: the shared libraries, the
|
|
coding standards, and how to get a project deployed.
|
|
|
|
This is a public site — it documents generic patterns and conventions. Real
|
|
infrastructure specifics (hostnames, internal IPs, exact topology, secrets) stay
|
|
out of it; examples use placeholders like `<workspace>`, `<project>`, and
|
|
`/srv/...`.
|
|
|
|
!!! tip "Point your coding agent here"
|
|
Want your agent aware of our libraries, standards, and deploy rules before it
|
|
writes a line? Tell it to read this handbook — so it reaches for an existing
|
|
`rethink-public` lib instead of reinventing it, follows our conventions, and
|
|
builds a deploy-ready container.
|
|
|
|
=== "From the live site"
|
|
|
|
```text
|
|
Read https://docs.rethinkstudios.io and follow it: prefer our
|
|
rethink-public libraries, match our coding standards, and make anything
|
|
deployable per the deploy guide.
|
|
```
|
|
|
|
=== "From git"
|
|
|
|
Point it straight at the repo — no need to clone into your project:
|
|
|
|
```text
|
|
Read the markdown under docs/ in
|
|
https://git.rethinkstudios.io/rethink-public/handbook and follow it:
|
|
prefer our rethink-public libraries, match our coding standards, and make
|
|
anything deployable per the deploy guide. Clone to /tmp if you need it
|
|
local.
|
|
```
|
|
|
|
## Sections
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-package-variant: __[Libraries](libraries.md)__
|
|
|
|
---
|
|
|
|
The live list of the `rethink-public` library suite, pulled straight from
|
|
Gitea — each entry links to the repo, where the README and tags live.
|
|
|
|
- :material-ruler-square: __[Standards](standards.md)__
|
|
|
|
---
|
|
|
|
House coding standards — file hygiene, docstrings, type hints, linting, and
|
|
how we handle errors.
|
|
|
|
- :material-sitemap: __[Workflow](workflow.md)__
|
|
|
|
---
|
|
|
|
Get hands on with how we dev — our Gitea, git habits, and the
|
|
plan-in-chat / build-in-Claude-Code flow, plus shell setup.
|
|
|
|
- :material-language-python: __[Virtual environments](environments.md)__
|
|
|
|
---
|
|
|
|
Project-based Python isolation — local `.venv`, Makefile, or Docker — and
|
|
local version management with pyenv.
|
|
|
|
- :material-rocket-launch: __[Deploy](deploy.md)__
|
|
|
|
---
|
|
|
|
How to get a project running on **rethink-net** — the compose convention,
|
|
the one-command deploy, and secrets.
|
|
|
|
</div>
|