From 7db2b36526dba1eb88c7f1dd80e1e5dc1cb8bd84 Mon Sep 17 00:00:00 2001 From: Cristian Magherusan-Stanciu Date: Wed, 10 Jun 2026 17:10:13 -0700 Subject: [PATCH] chore(repo): stop blanket-ignoring docs/, ignore only docs/generated/ The .gitignore blanket-ignored the entire docs/ directory while it contains tracked, hand-written documentation (DEPLOYMENT.md, DEVELOPMENT.md, smoke-test-multi-account.sh) and CLAUDE.md tells contributors to put documentation there. Any new file under docs/ was silently excluded from git add / git status, and substantive review docs had already accumulated untracked and invisible to git. Narrow the ignore to docs/generated/, the generated-runbook output the blanket rule was meant to cover, so hand-written docs are tracked normally. Also link docs/DEVELOPMENT.md from the README Development section so the guide is discoverable (DEPLOYMENT.md was already linked). Verified with git check-ignore: before, docs/new-doc.md matched .gitignore:137 (docs/); after, it is not ignored while docs/generated/runbook.md still is, and the three tracked docs/ files are unaffected. Closes #1169 --- .gitignore | 10 ++++++---- README.md | 4 ++++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index f3a667197..f8dd0dc52 100644 --- a/.gitignore +++ b/.gitignore @@ -135,10 +135,12 @@ security-audit-swarm/ # ~/.claude/CLAUDE.md §2a (Tool Selection) for the full rationale. .claude/ -# Generated docs (security runbooks etc.) and scratch/review files. -# docs/cli/ is explicitly tracked; all other docs/ subdirectories are ignored. -docs/* -!docs/cli +# Generated docs (security runbooks etc.). Only the generated output +# directory is ignored; hand-written documentation under docs/ is +# tracked normally (e.g. docs/DEPLOYMENT.md, docs/DEVELOPMENT.md, and the +# docs/cli/ CLI reference). Do not re-add a blanket docs/* ignore: it +# silently hid hand-written docs, which is the regression this narrows away. +docs/generated/ # Graphify knowledge graph output — regenerated locally, not committed graphify-out/ diff --git a/README.md b/README.md index 88e9c17a8..ac42b32dc 100644 --- a/README.md +++ b/README.md @@ -595,6 +595,10 @@ the dashboard. ## Development +See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) for the full development +guide, including the local Docker environment, database migrations, hot +reload, and debugging workflows. + ### Prerequisites - Go 1.23 or later