Profile My skills Saved Collections Edit profile Submit a skill

Docs Organize Reference Docs

Group an existing reference section into categories — propose the grouping from what the pages document, write each category's index page, and update sidebars.js without moving any file. Use when reorganizing an already-written reference section (any set of pages, not only single-type reference pages), rather than writing a new page.

zio d9be157 2 files · 7.7 KB Updated
Docs & Writing

File contents

Organize Reference Docs

The full procedure is in references/guide.md — how a grouping is proposed and checked, the category index page's shape, the sidebars.js rules, and the bounds that keep a reorganization from breaking links.

This targets an already-written reference section — any set of existing pages you are grouping, not only the single-type pages docs-organize-types categorizes. Read that skill's own scope note if the section you're reorganizing is exactly a set of per-type reference pages; either skill applies there, and this one adds the section-level receipt, the sidebars.js ESM/CJS verification gotcha, and the ordered verification pass in the guide below.

zio/zio-skills/tree/main/plugins/documentation/skills/docs-organize-reference-docs commit d9be157eab

Browse category

Frequently asked questions

npx skillmds@latest add zio/docs-organize-reference-docs