eSlider/swarm-house
1
0
Fork 0
Code Issues 2 Pull Requests 3 Actions Packages Projects 1 Releases 13 Wiki Activity

refactor: move scripts/ to bin/
CI & Release / Verify documentation (push) Skipped
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
CI & Release / Verify documentation (pull_request) Successful in 5s
Details
CI & Release / Verify simulator (pull_request) Failing after 10s
Details
CI & Release / Trivy scan (pull_request) Skipped
Details
CI & Release / Semantic Release (pull_request) Skipped
Details

Browse Source 
Relocate check_docs, check_adrs, and docs_rules; update CI, tests, and docs.
This commit is contained in:
eSlider
2026-07-10 10:59:22 +01:00
parent 10a18f1321
commit b4de3ed076
15 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/improvement/ci-rules.md
+6 -6
View File
@@ -2,7 +2,7 @@
Automated checks for markdown in this repository. Enforced on every **pull request** and on **push to `main`** (including docs-only pushes that skip the simulator gate).
Implementation: [`scripts/check_docs.py`](../../scripts/check_docs.py) reads [`scripts/docs_rules.yaml`](../../scripts/docs_rules.yaml).
Implementation: [`bin/check_docs.py`](../../bin/check_docs.py) reads [`bin/docs_rules.yaml`](../../bin/docs_rules.yaml).
Workflow: [`.github/workflows/release.yaml`](../../.github/workflows/release.yaml) job **`Verify documentation`**.
@@ -46,13 +46,13 @@ Docs-only changes therefore still get link and glossary validation on `main`; th
## Local run
```bash
python scripts/check_docs.py
python scripts/check_adrs.py --base origin/main
python scripts/check_docs.py --warnings-as-errors # treat section-link warnings as failures
python bin/check_docs.py
python bin/check_adrs.py --base origin/main
python bin/check_docs.py --warnings-as-errors # treat section-link warnings as failures
```
## Changing rules
1. Edit `scripts/docs_rules.yaml` (paths, banned targets, preferred anchors).
2. Adjust `scripts/check_docs.py` only when adding a new rule *type*.
1. Edit `bin/docs_rules.yaml` (paths, banned targets, preferred anchors).
2. Adjust `bin/check_docs.py` only when adding a new rule *type*.
3. Add a row to the table above and mention it in the audit/improvement record if the change is significant.