chore: consolidate docs and deploy guardrails#10
Merged
Conversation
Build a maintainable, agent- and human-readable knowledge system. Markdown in docs/ is the source of truth; Blume (blume.config.ts) is the presentation and search layer only. - AGENTS.md: rewrite as a concise agent bootloader (purpose, stack, essential commands, critical constraints, documentation navigation, maintenance rules). - STATUS.md: new short live operating view (objective, active work, blockers, unresolved questions, next steps, deferred). - PROJECT_STATUS.md: slimmed to durable product identity; live Todo/Deferred/ Blocked section moved to STATUS.md with a pointer. - docs/ reorganized into product/, architecture/(overview + decisions/ADRs), development/, operations/(deploy, host-setup, jobs, runbooks/), knowledge/ (learnings, gotchas, external-references, failed-approaches/), current/ (timeline), archive/(retros). Existing docs moved with git mv to preserve history; monolithic decisions.md split into per-ADR files. - blume.config.ts: renders docs/ only; root canonical docs (README, DEPLOY, PROJECT_STATUS, STATUS, AGENTS) stay GitHub-first and are linked, not duplicated. - scripts/check-docs.sh: pure-shell link + orphan + structure validator (docs/ internal links, root canonical doc links, empty dirs, required files). - scripts/build-docs.sh: Blume build/dev/preview wrapper (pinned, vetted-eligible version; runs check-docs.sh first). - .github/workflows/docs.yml: CI for docs validation on docs-touching paths, opt-in Blume build smoke. - .gitignore: Blume output (.blume/, blume-dist/, docs-dist/) and agent logs. - package.json: docs:check / docs:build / docs:dev / docs:preview scripts. Existing docs preserved and reorganized, not replaced. Unrelated in-progress change to web/src/pages/digest.astro left unstaged. Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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 and adds manual deploy guardrails plus digest metadata. Docs build is the relevant local check.