From 1fd92e19c9b9c33b91e2e7c1dc4297034a330008 Mon Sep 17 00:00:00 2001 From: rob Date: Tue, 6 Jan 2026 02:51:55 -0400 Subject: [PATCH] Improve CLAUDE.md template to reference updating-documentation.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- templates/CLAUDE.md.template | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/templates/CLAUDE.md.template b/templates/CLAUDE.md.template index c5404a8..d1b8774 100644 --- a/templates/CLAUDE.md.template +++ b/templates/CLAUDE.md.template @@ -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 `` / `` 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 `` / `` to hide sections +- Deploy: `~/PycharmProjects/project-docs/scripts/build-public-docs.sh {{PROJECT_NAME}} --deploy` Do NOT create documentation files directly in this repository.