disqualifier
75ad61b06a
A tip admonition under the intro telling devs to point their coding agent at the handbook for awareness of our libs/standards/deploy rules, with copy-pasteable agent prompts in two tabs: from the live site, or from a git clone of the repo. Verified in-browser: tabs switch, prompts + clone command render, copy buttons present; mkdocs build --strict clean. Signed-off-by: disqualifier <dev@disqualifier.me>
76 lines
2.3 KiB
Markdown
76 lines
2.3 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 `<dev>`, `<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"
|
|
|
|
```bash
|
|
git clone git@git.rethinkstudios.io:rethink-public/handbook.git
|
|
```
|
|
|
|
```text
|
|
Read the markdown under ./handbook/docs and follow it: prefer our
|
|
rethink-public libraries, match our coding standards, and make anything
|
|
deployable per the deploy guide.
|
|
```
|
|
|
|
## 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** — containers, paths and
|
|
mounts, permissions, and secrets.
|
|
|
|
</div>
|