Skip to content

Commit 22be9c2

Browse files
docs: fix build instructions and broken anchor
- docs_check is quick dev check, docs is required before commit - fix broken #run-qnx-unit-tests anchor after section rename
1 parent 1ec4098 commit 22be9c2

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,12 @@ The explanation chapters have specific ownership rules for cross-cutting topics.
7373
```bash
7474
bazel run //:docs # build documentation
7575
bazel run //:live_preview # local preview with live reload
76-
bazel run //:docs_check # validation — must pass cleanly
76+
bazel run //:docs_check # quick check during development
77+
bazel run //:docs # full build — required before commit
7778
bazel run //:ide_support # create .venv_docs for IDE integration
7879
```
7980

80-
A change is not complete until `bazel run //:docs_check` passes cleanly.
81+
A change is not complete until `bazel run //:docs` passes cleanly.
8182

8283
# Pre-commit Hooks
8384

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ For local work:
2929

3030
```bash
3131
bazel run //:live_preview # local preview with live reload
32-
bazel run //:docs_check # validation — must pass cleanly
32+
bazel run //:docs_check # quick check during development
33+
bazel run //:docs # full build — required before commit
3334
bazel run //:ide_support # create .venv_docs for IDE integration
3435
```
3536

36-
A contribution is not complete until `bazel run //:docs_check` passes cleanly.
37+
A contribution is not complete until `bazel run //:docs` passes cleanly.
3738

3839
The numbered chapter files under `docs/explanation/` drive the generated
3940
chapter-map section in `docs/explanation/index.md`. That section is refreshed
@@ -98,4 +99,4 @@ Before opening or merging a change, check the following:
9899
- Configuration details are concrete and minimal.
99100
- External procedures are linked, not copied.
100101
- Links and navigation still work.
101-
- `bazel run //:docs_check` passes.
102+
- `bazel run //:docs` passes.

docs/tutorials/itf-integration-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,5 +155,5 @@ You now have a working ITF test that:
155155
## Next steps
156156

157157
- [Write an ITF test against a QEMU target](../how-to/testing.md#write-an-itf-integration-test) — SSH-based interaction with a VM
158-
- [Run QNX unit tests](../how-to/testing.md#run-qnx-unit-tests) — cross-compiled tests in a QNX microvm
158+
- [Run QNX unit tests](../how-to/testing.md#advanced-qnx-unit-tests) — cross-compiled tests in a QNX microvm
159159
- [ITF framework explained](../explanation/04-testing-infrastructure.md#itf-framework) — plugin model, capability system, and traceability integration

0 commit comments

Comments
 (0)