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.