A loose federation of distributed, typed datasets
docs: document justfile and remove redundant dev/ scripts
Add justfile documentation to CLAUDE.md explaining the 'just docs' command.
Remove dev/build_docs.py and dev/docs scripts which are superseded by the
justfile recipe.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
+12
-70
.chainlink/issues.db
.chainlink/issues.db
This is a binary file and will not be displayed.
+1
CHANGELOG.md
+1
CHANGELOG.md
···
25
25
- **Comprehensive integration test suite**: 593 tests covering E2E flows, error handling, edge cases
26
26
27
27
### Changed
28
+
- Document justfile in CLAUDE.md (#372)
28
29
- Make docs script work from any directory (#371)
29
30
- Add uv script shortcut 'docs' for documentation build (#370)
30
31
- Update docstrings in local.py (#367)
+11
CLAUDE.md
+11
CLAUDE.md
···
41
41
uv build
42
42
```
43
43
44
+
### Development Scripts (justfile)
45
+
46
+
Development tasks are managed with [just](https://github.com/casey/just), a command runner. Available commands:
47
+
48
+
```bash
49
+
# Build documentation (runs quartodoc + quarto)
50
+
just docs
51
+
```
52
+
53
+
The `justfile` is in the project root. Add new dev tasks there rather than creating shell scripts.
54
+
44
55
### Running Python
45
56
```bash
46
57
# Always use uv run for Python commands to use the correct virtual environment
-58
dev/build_docs.py
-58
dev/build_docs.py
···
1
-
#!/usr/bin/env python3
2
-
"""Build documentation using quartodoc and quarto.
3
-
4
-
This script can be run from any directory within the project.
5
-
It finds the project root by locating pyproject.toml.
6
-
"""
7
-
8
-
import subprocess
9
-
import sys
10
-
from pathlib import Path
11
-
12
-
13
-
def find_project_root() -> Path:
14
-
"""Find project root by searching for pyproject.toml."""
15
-
current = Path(__file__).resolve().parent
16
-
while current != current.parent:
17
-
if (current / "pyproject.toml").exists():
18
-
return current
19
-
current = current.parent
20
-
raise RuntimeError("Could not find project root (no pyproject.toml found)")
21
-
22
-
23
-
def main() -> int:
24
-
"""Build documentation."""
25
-
project_root = find_project_root()
26
-
docs_src = project_root / "docs_src"
27
-
docs_out = project_root / "docs"
28
-
29
-
if not docs_src.exists():
30
-
print(f"Error: docs_src directory not found at {docs_src}", file=sys.stderr)
31
-
return 1
32
-
33
-
print(f"Building docs from {docs_src}")
34
-
35
-
# Run quartodoc build
36
-
result = subprocess.run(
37
-
["quartodoc", "build"],
38
-
cwd=docs_src,
39
-
)
40
-
if result.returncode != 0:
41
-
print("Error: quartodoc build failed", file=sys.stderr)
42
-
return result.returncode
43
-
44
-
# Run quarto render
45
-
result = subprocess.run(
46
-
["quarto", "render", "--output-dir", str(docs_out)],
47
-
cwd=docs_src,
48
-
)
49
-
if result.returncode != 0:
50
-
print("Error: quarto render failed", file=sys.stderr)
51
-
return result.returncode
52
-
53
-
print(f"Documentation built successfully in {docs_out}")
54
-
return 0
55
-
56
-
57
-
if __name__ == "__main__":
58
-
sys.exit(main())
-12
dev/docs
-12
dev/docs
···
1
-
#!/usr/bin/env bash
2
-
# Build documentation using quartodoc and quarto.
3
-
# Run from any directory in the project.
4
-
5
-
set -e
6
-
7
-
# Find script directory, then project root
8
-
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
9
-
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
10
-
11
-
cd "$PROJECT_ROOT"
12
-
uv run python dev/build_docs.py "$@"