h3cx/dpg-gauges
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

step 7: harden docs and prepare beta

Browse Source
This commit is contained in:
Hector van der Aa
2026-07-02 15:27:55 +02:00
parent f4716e0d19
commit ee5b60e620
13 changed files with 306 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
codex/AGENTS.md
View File

@@ -2,7 +2,7 @@
## Current status
Step 6 completed and verified with automated checks. Step 6 commit is pending.
Step 7 completed and verified with automated checks. Step 7 commit and beta tag are pending.
## Completed steps
@@ -30,6 +30,16 @@ Step 1 - Public API contract and pure core:
Step 7 - Documentation, hardening, and beta release.
Implemented during Step 7:
- Rewrote `README.md` with install, minimal examples, dashboard usage, GUI-thread expectations, animation/smoothing, and thresholds/markers.
- Added `docs/GETTING_STARTED.md`, `docs/EXAMPLES.md`, and `docs/API_REFERENCE.md`.
- Added docstrings for all public exported callables.
- Reviewed public API exports and added `__version__`.
- Added Step 7 hardening tests for unknown gauges, duplicate tags, invalid ranges, invalid thresholds, invalid markers, non-finite values, deleted updates, hidden sizing, and animation disabled/enabled behavior.
- Bumped package version to `0.1.0b1`.
- Verified a local editable install from a temporary project.
Step 6 - High-rate updates, animation, and stress examples:
Implemented during Step 6:
@@ -103,7 +113,7 @@ Implemented during Step 2:
## Known issues
Manual visual/stress example checks for Steps 3, 4, 5, and 6 were not run in this headless session.
Manual visual/stress example checks for Steps 3, 4, 5, 6, and 7 were not run in this headless session.
## Commands used
@@ -130,6 +140,16 @@ Manual visual/stress example checks for Steps 3, 4, 5, and 6 were not run in thi
- Ran `uv run ruff format .`.
- Ran `uv run ruff format --check .`.
- Ran `uv run pyright`.
- Committed Step 6 with `git commit -m "step 6: add animation and high rate update stress tests"` before starting Step 7.
- Read `codex/FEATURES.md`, `codex/ARCHITECTURE.md`, `codex/STEPS.md`, and `codex/AGENTS.md` before Step 7 changes.
- Implemented Step 7 README/docs, public callable docstrings, hardening tests, version bump, and README/API status updates.
- Ran `uv run python - <<'PY' ...` to verify all exported callables have docstrings.
- Ran `uv sync`.
- Ran `uv run pytest`.
- Ran `uv run ruff check .`.
- Ran `uv run ruff format --check .`.
- Ran `uv run pyright`.
- Created `/tmp/opencode/dpg-gauges-editable-check`, ran `uv init --bare --name dpg-gauges-editable-check`, `uv add --editable /home/hector/projects/dpg-gauges`, and `uv run python -c "import dpg_gauges as dpgg; print(dpgg.__name__)"`.
- Committed Step 5 with `git commit -m "step 5: complete first gauge catalogue"` before starting Step 6.
- Read `codex/FEATURES.md`, `codex/ARCHITECTURE.md`, `codex/STEPS.md`, and `codex/AGENTS.md` before Step 6 changes.
- Implemented Step 6 animation/smoothing scheduling refinements, high-rate examples, README status update, diagnostics fields, and tests.
@@ -162,4 +182,4 @@ Manual visual/stress example checks for Steps 3, 4, 5, and 6 were not run in thi
## Next action
Commit Step 6, then implement Step 7.
Commit Step 7 and tag `v0.1.0b1` if requested.