eSlider
b4de3ed076
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
CI & Release / Verify simulator (pull_request) Failing after 10s
CI & Release / Trivy scan (pull_request) Skipped
CI & Release / Semantic Release (pull_request) Skipped
Relocate check_docs, check_adrs, and docs_rules; update CI, tests, and docs.
48 lines
1.2 KiB
YAML
48 lines
1.2 KiB
YAML
# Documentation rules enforced by CI (bin/check_docs.py).
|
|
# See docs/improvement/ci-rules.md for rationale and PR workflow.
|
|
|
|
markdown_paths:
|
|
- docs/**/*.md
|
|
- README.md
|
|
- CONTRIBUTING.md
|
|
- AGENTS.md
|
|
- simulator/README.md
|
|
- prototype/README.md
|
|
- infra/**/README.md
|
|
|
|
glossary:
|
|
file: docs/00-glossary.md
|
|
|
|
# Relative link targets that must never reappear (known regressions).
|
|
banned_link_targets:
|
|
- 03-storage-design.md
|
|
|
|
# Glossary links to these section headers are allowed but reported as warnings
|
|
# when a term-specific ### anchor exists (see preferred_term_anchors).
|
|
glossary_section_anchors:
|
|
- data--storage
|
|
- swarm--robotics
|
|
- infrastructure--delivery
|
|
|
|
# First-use vocabulary should link to these ### anchors, not section headers.
|
|
preferred_term_anchors:
|
|
- t0--hot
|
|
- t1--warm
|
|
- t2--shared
|
|
- t3--warehouse
|
|
- t4--dev
|
|
- source-of-truth
|
|
- architecture-layer-1--ingestion
|
|
- architecture-layer-2--storage-and-transform
|
|
- architecture-layer-3--serving-and-sync
|
|
- pipeline-stage
|
|
- bulk-sync
|
|
- offload
|
|
- rclone
|
|
- adr
|
|
- asr
|
|
|
|
readability:
|
|
# Fail when prose uses bare "see 05" instead of a markdown link.
|
|
forbid_bare_see_refs: true
|