docs: consolidate knowledge system and workflow guardrails - #21
Merged
Conversation
Build a maintainable, agent- and human-readable documentation system with Markdown in docs/ as the source of truth and Blume as the presentation layer only. - AGENTS.md: slimmed to a concise bootloader (purpose, commands, constraints, docs navigation, maintenance rules); dropped the stale claude-mem-context. Case-only rename agents.md -> AGENTS.md for fleet convention. - STATUS.md: new short current-state view (objective, active work, blockers, unresolved questions, next steps). PROJECT_STATUS.md slimmed to a pointer for fleet tooling that reads it by name. - docs/: new canonical tree — index, product (overview/features/surfaces), architecture (overview/data-flow + 8 current ADRs), development (setup/commands/conventions/testing/openspec), operations (deploy/env/ci-cd/jobs + runbooks for schema/secrets/rollback), knowledge (current learnings/external-references/failed-approaches), archive index. - docs/archive/: moved pre-Vite decisions.md, lessons.md, learning docs, PROJECT_RECOMMENDATION_CONTEXT, AUDIT, Firebase migration plan + retro, memory-capture plans, chrome-extension plan via git mv; added historical markers pointing at current canonical docs. plans/ folder removed. - blume.config.ts: presentation-only config pointing at docs/ (archive/ excluded from the published site). Not part of the production build. - scripts/check-docs.mjs + pnpm docs:check: validates docs/ link integrity, orphan files, required files, and canonical structure. CI wired via .github/workflows/docs.yml on docs/AGENTS/STATUS/blume paths. - .gitignore: ignore Blume output (.blume/, docs-site/) and local agent logs. - package.json: add docs:check / docs:dev / docs:build scripts. Unrelated in-progress work (dist/, landing-astro pages, public/llms.txt, src/worker.ts) is preserved untouched. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
reader | ce43b1b | Jul 18 2026, 11:35 PM |
3 tasks
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
1 participant
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.
Consolidates repository docs, landing FAQ metadata, and workflow timeout guardrails. Reader tests and typecheck pass locally; generated dist artifacts remain parked in a named stash.