Files
handbook/docs/index.md
T
dsql 350884c2b3 deploy: whole-flow as plain text, restore v2 diagram shape; admonition variety
- 'The whole flow' is now plain prose, not an abstract box.
- Restore the v2 diagram shape (git -> staging via develop-if-gitflow AND
  git -> deployment, converging on docker) instead of the linear main-only
  one, keeping the simplified 'libs (rethink-public, pip)' wording.
- Spread admonition types for variety across pages: index agent-callout
  tip -> example; environments uv.lock note -> info; standards logging
  note -> info. (deploy already mixes success/danger/example/warning/tip.)

Verified in-browser: whole-flow reads as text, diagram renders in the v2
shape; mkdocs build --strict clean.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-07-01 03:04:51 -04:00

2.4 KiB

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/....

!!! example "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

  • :material-package-variant: Libraries


    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


    House coding standards — file hygiene, docstrings, type hints, linting, and how we handle errors.

  • :material-sitemap: Workflow


    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


    Project-based Python isolation — local .venv, Makefile, or Docker — and local version management with pyenv.

  • :material-rocket-launch: Deploy


    How to get a project running on rethink-net — the compose convention, the one-command deploy, and secrets.