docs: cross-link registry operations runbook (XDE-96)#6
Conversation
Link getskillpack/registry REFERENCE_REGISTRY_OPERATIONS_RU from QUICKSTART, docs index, and engineering traceability for operators/maintainers. Co-Authored-By: Paperclip <noreply@paperclip.ing> Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
This PR adds explicit cross-references from the CLI documentation to the registry operations runbook in the getskillpack/registry repository, making it easier for operators/maintainers to discover the canonical prod-ops guidance.
Changes:
- Add a new row in
docs/README.mdpointing to the registry operations runbook. - Add a new bullet in
docs/QUICKSTART.mdalongside the registry API link. - Add a related-docs bullet in
docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.mdreferencing the runbook.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/README.md | Adds an operations-doc index entry linking to the registry runbook. |
| docs/QUICKSTART.md | Adds a runbook link next to the registry API “source of truth” section. |
| docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md | Adds a related-doc reference to the registry runbook. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Registry HTTP contracts and stability notes live in the **`getskillpack/registry`** repository: | ||
|
|
||
| - [API.md](https://github.com/getskillpack/registry/blob/main/API.md) | ||
| - [REFERENCE_REGISTRY_OPERATIONS_RU.md](https://github.com/getskillpack/registry/blob/main/docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) — прод-хостинг и операции реестра (runbook для операторов и мейнтейнеров) |
There was a problem hiding this comment.
This is an English quickstart (see title/header), but this newly added bullet’s description is entirely in Russian. Consider switching the description to English (and optionally adding “(RU)” to clarify the linked runbook language) so the section stays consistently readable for the target audience.
| - [REFERENCE_REGISTRY_OPERATIONS_RU.md](https://github.com/getskillpack/registry/blob/main/docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) — прод-хостинг и операции реестра (runbook для операторов и мейнтейнеров) | |
| - [REFERENCE_REGISTRY_OPERATIONS_RU.md](https://github.com/getskillpack/registry/blob/main/docs/REFERENCE_REGISTRY_OPERATIONS_RU.md) — production hosting and registry operations runbook for operators and maintainers (RU) |
| @@ -31,5 +31,6 @@ | |||
|
|
|||
| ## Связанные документы в этом репозитории | |||
There was a problem hiding this comment.
This bullet points to a document in a different repository, but it’s under the header “Связанные документы в этом репозитории”. Consider adjusting the header wording (e.g., drop “в этом репозитории” or split into “в этом репозитории” vs “в других репозиториях”) so the section structure matches the links it contains.
| ## Связанные документы в этом репозитории | |
| ## Связанные документы |
Summary
Adds explicit cross-links from
getskillpack/clidocs to the registry operations runbookdocs/REFERENCE_REGISTRY_OPERATIONS_RU.mdin getskillpack/registry.Changes
docs/QUICKSTART.md— next toAPI.mdunder registry repo pointers (operators / maintainers).docs/README.md— operations table row for prod hosting / maintainer ops.docs/ENGINEERING_REQUIREMENTS_TRACEABILITY_RU.md— related-docs bullet for traceability.Refs: internal ticket XDE-96.