Skip to content

Commit 3674ec4

Browse files
committed
docs: add maturity docs routes
1 parent 0dfa22c commit 3674ec4

4 files changed

Lines changed: 12 additions & 0 deletions

File tree

.github/labeler.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@
118118
- any-glob-to-any-file:
119119
- "extensions/qa-lab/**"
120120
- "qa/scenarios/**"
121+
- "docs/maturity/**"
121122
- "docs/concepts/qa-e2e-automation.md"
122123
- "docs/concepts/personal-agent-benchmark-pack.md"
123124
- "docs/channels/qa-channel.md"

docs/AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ This directory owns docs authoring, Mintlify link rules, and docs i18n policy.
2424
- `scripts/docs-sync-publish.mjs` excludes and prunes `docs/internal/**` from the public `openclaw/docs` publish repo if a page is force-added later.
2525
- Internal docs may mention repo paths, private app names, 1Password item names, and runbooks, but never include secret values.
2626

27+
## Maturity Scorecard Editing
28+
29+
`taxonomy.yaml` and `qa/maturity-scores.yaml` are the source inputs; generated maturity docs under `docs/maturity/` are projections and should not be hand-edited for score, LTS, taxonomy, QA profile, or evidence tables.
30+
`scripts/qa/render-maturity-docs.ts` owns generation; use `pnpm maturity:render` to refresh committed docs and `pnpm maturity:check` to verify them.
31+
`.github/workflows/maturity-scorecard.yml` renders artifact previews and can open generated-doc PRs; `.github/workflows/openclaw-release-checks.yml` dispatches it for release QA.
32+
Keep deterministic `qa-evidence.json.scorecard` data in GitHub Actions artifacts unless a maintainer explicitly asks for a sanitized committed projection.
33+
Human overrides must change source state in a PR and explain the reason plus public or redacted evidence.
34+
2735
## Docs i18n
2836

2937
- Foreign-language docs are not maintained in this repo. The generated publish output lives in the separate `openclaw/docs` repo (often cloned locally as `../openclaw-docs`).

docs/concepts/qa-e2e-automation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -966,6 +966,7 @@ output and whose artifact paths are resolved relative to that producer
966966
`qa run --qa-profile`, the same `qa-evidence.json` also includes the profile
967967
scorecard summary for the selected taxonomy categories.
968968
Treat it as a discovery aid, not a gate replacement; the selected scenario still needs the right provider mode, live transport, Multipass, Testbox, or release lane for the behavior under test.
969+
For scorecard context, see [Maturity scorecard](/maturity/scorecard).
969970

970971
For character and style checks, run the same scenario across multiple live model
971972
refs and write a judged Markdown report:
@@ -1023,6 +1024,7 @@ When no `--judge-model` is passed, the judges default to
10231024
## Related docs
10241025

10251026
- [Matrix QA](/concepts/qa-matrix)
1027+
- [Maturity scorecard](/maturity/scorecard)
10261028
- [Personal agent benchmark pack](/concepts/personal-agent-benchmark-pack)
10271029
- [QA Channel](/channels/qa-channel)
10281030
- [Testing](/help/testing)

docs/help/testing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ of Docker runners. This doc is a "how we test" guide:
2020

2121
- [QA overview](/concepts/qa-e2e-automation) - architecture, command surface, scenario authoring.
2222
- [Matrix QA](/concepts/qa-matrix) - reference for `pnpm openclaw qa matrix`.
23+
- [Maturity scorecard](/maturity/scorecard) - how release QA evidence supports stability and LTS decisions.
2324
- [QA channel](/channels/qa-channel) - the synthetic transport plugin used by repo-backed scenarios.
2425

2526
This page covers running the regular test suites and Docker/Parallels runners. The QA-specific runners section below ([QA-specific runners](#qa-specific-runners)) lists the concrete `qa` invocations and points back at the references above.

0 commit comments

Comments
 (0)