rethink-public/handbook
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
bad61bea2d
handbook/docs/index.md
disqualifier bad61bea2d scaffold MkDocs Material handbook site 
Initialize the public Rethink Studios docs site:
- mkdocs.yml: Material theme, light/dark palette toggle, pymdownx
  extensions, search, four-section nav skeleton.
- docs/index.md landing page with a card grid.
- Stub index pages for deploy, conventions, libraries, runbooks.
- .gitignore excludes .claude/, site/, and Python build cruft.

Deploy guide deferred; deploy section is a placeholder for now.

Signed-off-by: disqualifier <dev@disqualifier.me>
2026-06-29 19:29:30 -04:00

1.4 KiB
Raw Blame History

Rethink Studios Handbook

The shared reference for how we build, deploy, and operate. Generic patterns and conventions live here — sanitized for public consumption. Real infrastructure specifics (hostnames, internal IPs, secrets, exact topology) stay in our private runbooks.

Sections

  • :material-rocket-launch: Deploy

    How services get from a repo to running behind the proxy — container standards, compose patterns, and step-by-step deploy guides.

  • :material-ruler-square: Conventions

    Coding, library, and infrastructure conventions. Naming, layout, logging, and the rules that keep things consistent across projects.

  • :material-package-variant: Libraries

    Usage docs for the shared rethink-public library suite — what each lib does and how to wire it into a project.

  • :material-tools: Runbooks

    Operational how-tos for recurring tasks — sanitized for public reference.

Conventions for this handbook

  • One topic per page, grouped by section directory.
  • Public means sanitized: use placeholders (<host>, <dev>, /srv/...) and describe the pattern, not our literal infrastructure.
  • Code blocks are tagged with their language and kept copy-pasteable.