Architecture, README, standards, CLAUDE.md, settings reference, indexes, backlog, release plans and CHANGELOG checked against the code at v2.14.0: backfeed, notifications, counts line and web actions documented; test policy (changed area locally, full suite in CI); stale versions, statuses and links fixed; legacy and superseded docs moved. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.4 KiB
2.4 KiB
Architecture Documentation Index
This directory describes the current design of StarPunk (v2.14.0). Per ../DOCUMENTATION.md it is updated at the end of each release. Decisions and their history are in ../decisions/; per-release designs and reports are in ../design/. The original v0.x technology choices are kept in ../design/v0.x/technology-stack-legacy.md.
Documents
| Document | Description |
|---|---|
| overview.md | System overview: purpose, request flow, modules and routes, background workers, storage, auth model, URL surface, caching, security posture |
| technology-stack.md | Current runtime, Python dependencies, standards implemented, testing and CI |
| database.md | SQLite schema after migrations 001–021, migration runner and its lock, connection pool |
| deployment.md | Container image stages, CI workflow, release process, /data layout, reverse proxy, all environment variables |
| simplified-auth-architecture.md | Admin login via OpenID Connect and the built-in IndieAuth server that issues Micropub tokens (ADR-064) |
| indieweb-protocols.md | How Micropub, IndieAuth, Webmention, microformats2, WebSub and the feeds are implemented (including backfeed responses, web actions and notifications), with compliance status and known gaps |
| syndication-architecture.md | Crossposting (POSSE) to GoToSocial, Bluesky and Threads: syndications table, worker, reconcile rules, backfeed of responses (ADR-073) |
Where to start
- New to the code: overview.md, then technology-stack.md.
- Changing the schema: database.md (migrations must be safe inside one transaction).
- Releasing or operating the site: deployment.md.
- Working on auth, Micropub, Webmention or WebSub: simplified-auth-architecture.md and indieweb-protocols.md, plus the ADRs they link to.
Related documentation
- ../decisions/: Architectural Decision Records (ADRs)
- ../design/: designs, questions and reports per version
- ../standards/: coding, testing and versioning standards
- ../projectplan/: backlog and release plans
Last Updated: 2026-11-10 (v2.14.0)