docs(readme): ecosystem documentation map (XDE-103) - #4
Conversation
Link in-repo runbooks, CLI compatibility matrix, and engineering traceability doc without duplicating runbook content. Co-Authored-By: Paperclip <noreply@paperclip.ing> Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
Adds an ecosystem “documentation map” section to the root README to help operators/engineers find runbooks and cross-repo docs without duplicating operational content.
Changes:
- Introduces a new “Where things live” subsection under the operators area in
README.md. - Adds links to in-repo runbooks and to CLI-repo docs (compatibility matrix and requirements traceability).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **Compatibility matrix** (CLI, skillget-manager, registry): [`COMPATIBILITY_MATRIX_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/COMPATIBILITY_MATRIX_RU.md) — cross-repo alignment (delivery context: Paperclip **XDE-100**). | ||
| - **CLI + skillget-manager + traceability to requirements / tickets:** [`ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md) (delivery context: Paperclip **XDE-99**). |
There was a problem hiding this comment.
The bullets reference “skillget-manager” as if it’s part of the current ecosystem (“Compatibility matrix (CLI, skillget-manager, registry)” and “CLI + skillget-manager…”). docs/PUBLIC_ECOSYSTEM.md states the historical getskillpack/skillget-manager repo was removed and must not be referenced as an active dependency. Please rename these parentheticals to avoid implying skillget-manager is an active component (or explicitly mark it as retired/legacy if it must be mentioned).
| - **Compatibility matrix** (CLI, skillget-manager, registry): [`COMPATIBILITY_MATRIX_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/COMPATIBILITY_MATRIX_RU.md) — cross-repo alignment (delivery context: Paperclip **XDE-100**). | |
| - **CLI + skillget-manager + traceability to requirements / tickets:** [`ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md) (delivery context: Paperclip **XDE-99**). | |
| - **Compatibility matrix** (CLI, historical `skillget-manager` prototype, registry): [`COMPATIBILITY_MATRIX_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/COMPATIBILITY_MATRIX_RU.md) — cross-repo alignment (delivery context: Paperclip **XDE-100**). | |
| - **CLI + historical (retired) `skillget-manager` prototype + traceability to requirements / tickets:** [`ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md`](https://github.com/getskillpack/cli/blob/main/docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md) (delivery context: Paperclip **XDE-99**). |
| ### Where things live | ||
|
|
||
| Pointers into ecosystem documentation (no duplicate runbook prose here — follow the links): | ||
|
|
There was a problem hiding this comment.
PR description says the root README “stays English-only” per docs/ORG_README_POLICY.md, but the current README still contains Russian text (e.g., the “## For operators / Для операторов” header). Either update the README to comply with the policy (English-only root README) or adjust the PR description to reflect the current state/policy exception.
|
|
||
| Pointers into ecosystem documentation (no duplicate runbook prose here — follow the links): | ||
|
|
||
| - **Ops / runbooks (this repository):** [`docs/PUBLIC_REGISTRY_RUNBOOK.md`](./docs/PUBLIC_REGISTRY_RUNBOOK.md) (public instance SLO, secrets, backups, alerts) · [`docs/REFERENCE_REGISTRY_OPERATIONS_RU.md`](./docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) (short deploy/update and operations outline) |
There was a problem hiding this comment.
docs/PUBLIC_REGISTRY_RUNBOOK.md is written in Russian (its title/content are RU). In this new “Where things live” list, consider labeling the runbook link as “(RU)” for consistency with the Contents section below, so English-only readers immediately know what to expect before clicking.
| - **Ops / runbooks (this repository):** [`docs/PUBLIC_REGISTRY_RUNBOOK.md`](./docs/PUBLIC_REGISTRY_RUNBOOK.md) (public instance SLO, secrets, backups, alerts) · [`docs/REFERENCE_REGISTRY_OPERATIONS_RU.md`](./docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) (short deploy/update and operations outline) | |
| - **Ops / runbooks (this repository):** [`docs/PUBLIC_REGISTRY_RUNBOOK.md`](./docs/PUBLIC_REGISTRY_RUNBOOK.md) (RU; public instance SLO, secrets, backups, alerts) · [`docs/REFERENCE_REGISTRY_OPERATIONS_RU.md`](./docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) (short deploy/update and operations outline) |
Remove Cyrillic from the For operators heading; RU ops doc link unchanged. Co-Authored-By: Paperclip <noreply@paperclip.ing> Made-with: Cursor
|
CI fix: root Pushed |
Summary
Adds a Where things live section to the root README: pointers to in-repo ops/runbooks, the CLI compatibility matrix, and engineering requirements traceability — without duplicating runbook prose.
Links
docs/PUBLIC_REGISTRY_RUNBOOK.md,docs/REFERENCE_REGISTRY_OPERATIONS_RU.mdgetskillpack/clidocs/COMPATIBILITY_MATRIX_RU.mdgetskillpack/clidocs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.mdRoot README stays English-only per
docs/ORG_README_POLICY.md.