50 lines
1.2 KiB
Plaintext
50 lines
1.2 KiB
Plaintext
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
**{{PROJECT_TITLE}}** - {{PROJECT_TAGLINE}}
|
|
|
|
## Development Commands
|
|
|
|
```bash
|
|
# Install for development
|
|
pip install -e ".[dev]"
|
|
|
|
# Run tests
|
|
pytest
|
|
|
|
# Run a single test
|
|
pytest tests/test_file.py::test_name
|
|
```
|
|
|
|
## Architecture
|
|
|
|
*TODO: Describe the project architecture*
|
|
|
|
### Key Modules
|
|
|
|
*TODO: List key modules and their purposes*
|
|
|
|
### Key Paths
|
|
|
|
- **Source code**: `src/{{PROJECT_NAME}}/`
|
|
- **Tests**: `tests/`
|
|
- **Documentation**: `docs/` (symlink to project-docs)
|
|
|
|
## Documentation
|
|
|
|
Documentation for this project lives in the centralized docs system:
|
|
|
|
- **Source**: `~/PycharmProjects/project-docs/docs/projects/{{PROJECT_NAME}}/`
|
|
- **Public URL**: `https://pages.brrd.tech/{{GITEA_OWNER}}/{{PROJECT_NAME}}/`
|
|
|
|
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
|
|
|
|
Do NOT create documentation files directly in this repository.
|