dsql
f9e5e4f24d
The Deploy page got long and the code annotations rendered inconsistently
(some as (n) numbers, some as clickable +, and a marker on a fully-commented
line made that line vanish). Fix both:
- Deploy is now a HUB (docs/deploy/index.md): the intro + collision rule +
central-deploy note, then card links to three focused sub-pages. Deploy
stays the single global-nav entry; sub-pages are not_in_nav, reached from
the hub cards.
- deploy/compose.md — compose convention, storage tiers, how deploy fills
it in, subprocess/browser knobs, checklist
- deploy/dockerfile.md — services-account image, COPY, layer caching, uv
- deploy/secrets.md — keeping secrets out of the image
- Replace code annotations with INLINE COMMENTS on the compose/Dockerfile
examples: everything visible at once, no + to click, and the commented
MOUNTS_DIR line no longer disappears.
- Update inbound links (index card, standards, workflow, environments) to
deploy/ and deploy/compose.md; nav Deploy -> deploy/index.md with
not_in_nav for the sub-pages.
Verified in-browser: hub cards link correctly, sub-pages render with visible
inline comments (0 annotation markers), left nav shows only Deploy;
mkdocs build --strict clean (validates not_in_nav + all cross-links).
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/)__
|
|
|
|
---
|
|
|
|
How to get a project running on **rethink-net** — the compose convention,
|
|
the one-command deploy, and secrets.
|
|
|
|
</div>
|