rob
/
development-hub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve CLAUDE.md template to reference updating-documentation.md 

Added bold instruction to read docs/updating-documentation.md before
updating docs. This ensures AI assistants read the full visibility
rules and procedures.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
rob 2026-01-06 02:51:55 -04:00
parent ec08f878f7
commit 1fd92e19c9
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
templates/CLAUDE.md.template
View File

@ -35,15 +35,14 @@ pytest tests/test_file.py::test_name
## Documentation
Documentation for this project lives in the centralized docs system:
Documentation lives in `docs/` (symlink to centralized docs system).
- **Source**: `~/PycharmProjects/project-docs/docs/projects/{{PROJECT_NAME}}/`
- **Public URL**: `https://pages.brrd.tech/{{GITEA_OWNER}}/{{PROJECT_NAME}}/`
**Before updating docs, read `docs/updating-documentation.md`** for full details on visibility rules and procedures.
When updating documentation:
1. Edit files in `docs/` (the symlink) or the full path above
2. Use `public: true` frontmatter for public-facing docs
3. Use `<!-- PRIVATE_START -->` / `<!-- PRIVATE_END -->` to hide sections
4. Run `~/PycharmProjects/project-docs/scripts/build-public-docs.sh {{PROJECT_NAME}} --deploy` to publish
Quick reference:
- Edit files in `docs/` folder
- Use `public: true` frontmatter for public-facing docs
- Use `<!-- PRIVATE_START -->` / `<!-- PRIVATE_END -->` to hide sections
- Deploy: `~/PycharmProjects/project-docs/scripts/build-public-docs.sh {{PROJECT_NAME}} --deploy`
Do NOT create documentation files directly in this repository.