docs(home-config): standards file and build/run/test in the README (hc-135) #619

Merged

kblack0610 merged 3 commits from docs/hc-135-dev-docs into master 2026-11-06 17:03:42 +00:00

Conversation 0 Commits 3 Files changed 3 +47

kblack0610 commented 2026-11-06 16:32:32 +00:00

Owner

Copy link

Summary

• New docs/standards.md: 12 rules, each with why and the check behind it (CI script, job, or "none; review"), drawn from checks.yaml, the scripts/check-*.py docstrings, docs/gitops.md and CLAUDE.md.
• README: new "Build, Run and Test" section with the commands CI runs; link to the standards file in "Start Here".
• docs/README.md: index row for the standards file.
• docs/architecture.md already existed and passed; untouched.

Checks

• project-stage-check home-config --system docs: 2/3 before; the standards predicate passes on this branch.
• Ran locally, all exit 0: the four scripts/check-*.py, test_exporter.py, test_governor.py, test-ci-disk-prune.sh, apps/zomboid/tests/run.sh.
• Not run locally (no kustomize, promtool, yq on this host): the kustomize build and promtool commands in the README are copied from checks.yaml; CI runs them.

assumed: the standards file lists only rules already stated in the repo's docs and enforced or named by a script, not new policy, because the task says content from the code.
assumed: rules with no automated check say "none; review" rather than invent one.

Item: ar390-hc-135
Task: hc-138

## Summary - New `docs/standards.md`: 12 rules, each with why and the check behind it (CI script, job, or "none; review"), drawn from `checks.yaml`, the `scripts/check-*.py` docstrings, `docs/gitops.md` and `CLAUDE.md`. - README: new "Build, Run and Test" section with the commands CI runs; link to the standards file in "Start Here". - `docs/README.md`: index row for the standards file. - `docs/architecture.md` already existed and passed; untouched. ## Checks - `project-stage-check home-config --system docs`: 2/3 before; the standards predicate passes on this branch. - Ran locally, all exit 0: the four `scripts/check-*.py`, `test_exporter.py`, `test_governor.py`, `test-ci-disk-prune.sh`, `apps/zomboid/tests/run.sh`. - Not run locally (no `kustomize`, `promtool`, `yq` on this host): the `kustomize build` and promtool commands in the README are copied from `checks.yaml`; CI runs them. assumed: the standards file lists only rules already stated in the repo's docs and enforced or named by a script, not new policy, because the task says content from the code. assumed: rules with no automated check say "none; review" rather than invent one. Item: ar390-hc-135 Task: hc-138

kblack0610 added 1 commit 2026-11-06 16:32:32 +00:00

docs(home-config): add standards.md and a build/run/test section to the README ... ced6549ecc

Closes the one #dev docs row project-stage-check reported (a standards file); the README gains the build, run and test commands CI runs.

kblack0610 added 1 commit 2026-11-06 16:32:37 +00:00

Merge remote-tracking branch 'forgejo/master' into docs/hc-135-dev-docs 08895da1e7

kblack0610 added 1 commit 2026-11-06 17:03:18 +00:00

docs(standards): do not name the retired ansible-vault tool, check-secret-store rejects it 6837ae70a0

kblack0610 merged commit b25815a243 into master 2026-11-06 17:03:42 +00:00

kblack0610 referenced this pull request from a commit 2026-11-06 17:03:43 +00:00

docs(home-config): standards file and build/run/test in the README (hc-135) (#619)

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

No items

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

kblack0610/home-config!619

No description provided.