Skip to content

Commit 2a808e6

Browse files
snopokeclaude
andcommitted
add CLAUDE.md and fix stale README install command
Documents the uv-based workflow, mkdocstrings dependency on the sibling taskbadger-python checkout via TB_PYTHON_SRC, and the auto-deploy on push to main. Also corrects README to use `uv sync` instead of the stale `pip install requirements.txt`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent a469f7f commit 2a808e6

2 files changed

Lines changed: 38 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Task Badger Docs
2+
3+
Mkdocs-material documentation site for Task Badger. Published to https://docs.taskbadger.net.
4+
5+
## Commands
6+
7+
```bash
8+
uv sync # Install deps (use uv, not pip — README is stale)
9+
inv serve # Dev server on http://localhost:8082
10+
uv run mkdocs serve -a localhost:8082 # Equivalent without invoke
11+
uv run mkdocs build # Build static site to ./site/
12+
```
13+
14+
## Architecture
15+
16+
- Content: Markdown files in `docs/`
17+
- Config: `mkdocs.yml` (theme, nav, plugins, markdown extensions)
18+
- Tasks: `tasks.py` (invoke tasks)
19+
20+
## Sibling repo dependency
21+
22+
The Python SDK reference pages use `mkdocstrings` to pull docstrings from a sibling
23+
checkout of `taskbadger-python`. Path is set via `TB_PYTHON_SRC` (defaults to
24+
`../taskbadger-python`). Without it sitting next to this repo, SDK pages won't render
25+
properly. mkdocs also `watch:`es that path during `mkdocs serve`.
26+
27+
## Navigation
28+
29+
The site nav is controlled by the `nav:` block in `mkdocs.yml`, **not** by the
30+
filesystem. Adding a new `.md` file under `docs/` doesn't make it appear in the
31+
sidebar — add it to `nav:` too.
32+
33+
## Deployment
34+
35+
Push to `main` triggers `.github/workflows/deploy.yml`, which runs
36+
`uv run mkdocs gh-deploy --force`. There is no staging — main goes live.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ See https://docs.taskbadger.net
44

55
## Setup
66

7-
```python
8-
pip install requirements.txt
7+
```bash
8+
uv sync
99
inv serve
1010
```

0 commit comments

Comments
 (0)