Skip to content

Commit 43ceec2

Browse files
committed
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
1 parent 8b7be67 commit 43ceec2

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

‎.gitignore‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,10 @@ security-audit-swarm/
135135
# ~/.claude/CLAUDE.md §2a (Tool Selection) for the full rationale.
136136
.claude/
137137

138-
# Generated docs (security runbooks etc.)
139-
docs/
138+
# Generated docs (security runbooks etc.). Only the generated output
139+
# directory is ignored; hand-written documentation under docs/ is
140+
# tracked normally (e.g. docs/DEPLOYMENT.md, docs/DEVELOPMENT.md).
141+
docs/generated/
140142

141143
# Graphify knowledge graph output — regenerated locally, not committed
142144
graphify-out/

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,10 @@ the dashboard.
585585

586586
## Development
587587

588+
See [`docs/DEVELOPMENT.md`](docs/DEVELOPMENT.md) for the full development
589+
guide, including the local Docker environment, database migrations, hot
590+
reload, and debugging workflows.
591+
588592
### Prerequisites
589593

590594
- Go 1.23 or later

0 commit comments

Comments
 (0)