Review 9 — Docs: architecture map, development guide, roadmap - #33
Draft
ArneeMe wants to merge 1 commit into
Draft
Review 9 — Docs: architecture map, development guide, roadmap#33ArneeMe wants to merge 1 commit into
ArneeMe wants to merge 1 commit into
Conversation
Three companion documents for future development (human or AI): - docs/ARCHITECTURE.md — stack, data model, the three core flows, security model, and the things that look wrong but are deliberate. - docs/DEVELOPMENT.md — commands, the full verification checklist, conventions (strings/i18n pattern, API route pattern, migrations workflow, test placement) and the gotchas that have cost real time. - docs/ROADMAP.md — parked work with reasoning captured (regeneration window from issuance, hash v2 hatch, revocation, media storage, dedicated-backend evaluation) so options don't get re-derived. CLAUDE.md points to them and mandates keeping all four truthful in the same commit as any invariant change; README links docs/. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BFHkXUuHJME4cF9AJWbavB
Deploying inf319-certificate with
|
| Latest commit: |
1894a19
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://bb356a20.inf319-certificate.pages.dev |
| Branch Preview URL: | https://claude-review-9-docs.inf319-certificate.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #32 (part 9 of the review stack). Documentation only — easy approve, and specifically written so future AI-assisted development starts with full context instead of re-deriving it:
docs/ARCHITECTURE.md— stack, data model, the three core flows (submit/issue/verify), the security model, and a "things that look wrong but are deliberate" section (two verify routes,submission_idon certs, hash excludingt, no Hasura permissions, no cron).docs/DEVELOPMENT.md— commands, the exact verification checklist CI runs, the conventions every PR in this stack follows (strings/i18n pattern, API route pattern, migrations-in-two-places rule, pure-module test placement), and the gotchas that have cost real time (stale.next/types,export {}in scripts,PW_CHROMIUM_PATH, MUI Rating in e2e).docs/ROADMAP.md— parked work with the reasoning captured: the 24h-from-issuance window option, hash-v2 hatch, revocation, media storage, the dedicated-backend evaluation and why it was rejected for now.CLAUDE.md points at all three and mandates keeping the docs truthful in the same commit as any invariant change. README links
docs/.Verification: typecheck + lint pass (content-only change otherwise).
🤖 Generated with Claude Code
https://claude.ai/code/session_01BFHkXUuHJME4cF9AJWbavB
Generated by Claude Code