Skip to content

Update CLAUDE.md to discourage slop markdown files #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeremyeder merged 2 commits into from
Dec 4, 2025
Merged

Update CLAUDE.md to discourage slop markdown files #420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acd0fa9
Update CLAUDE.md to discourage slop markdown files
jwm4 Dec 4, 2025
d3ce246
Address auto-review comments
jwm4 Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -985,6 +985,15 @@ The MkDocs site (`mkdocs.yml`) provides:
- Production: Jira integration, OpenShift deployment, scaling
- **Reference**: Agent personas, API endpoints, configuration schema, glossary

### Documentation Standards

**Default to improving existing documentation** rather than creating new files. When adding or updating documentation (standalone files like `.md`, design docs, guides):

- **Prefer inline updates**: Improve existing markdown files or code comments
- **Colocate new docs**: When feasible, documentation should live in the subdirectory that has the relevant code (e.g., `components/backend/README.md`) not at the top level
- **Avoid top-level proliferation**: Only create top-level docs for cross-cutting concerns (architecture, security, deployment)
- **Follow established patterns**: See `docs/amber-quickstart.md` and `components/backend/README.md` for examples of well-organized documentation

### Director Training Labs

Special lab track for leadership training located in `docs/labs/director-training/`:
Expand Down
Loading