You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .claude/skills/docs-review/SKILL.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,8 @@ The docs follow a product-area-based information architecture under `docs/toolhi
70
70
-**Self-contained sections**: Product-specific content belongs in its product section (`docs/toolhive/guides-ui/`, `guides-cli/`, `guides-k8s/`, `guides-vmcp/`, `guides-registry/`), not in a shared section.
71
71
-**Quickstarts in product sections**: Quickstarts live inside their product section, not in a separate top-level section.
72
72
-**Integration placement**: Third-party integration guides (ngrok, Vault, OpenTelemetry, Okta, etc.) belong in `integrations/`, not in a product section.
73
-
-**Next steps section**: Every how-to guide and tutorial page must end with a "Next steps" section containing 1-3 forward links. Missing "Next steps" is a primary issue.
73
+
-**Page ending pattern**: How-to guides and tutorials follow this closing pattern: Next steps > Related information > Troubleshooting (if applicable). "Next steps" contains 1-3 forward links to the next logical pages. Missing "Next steps" is a primary issue.
74
+
-**Inbound link coverage for new pages**: When a PR adds a new page, check that it is reachable beyond just the sidebar. New pages need inbound links from related pages (overviews, intros, feature lists, related how-to guides). A page with no inbound links is isolated in the user journey. For major new features, also check whether top-level intro/overview pages should mention the capability.
74
75
-**Introduction pages**: Each product section should have an Introduction as the first sidebar child. New sections must follow this pattern.
75
76
-**Progressive disclosure**: Core workflows should appear before advanced topics. Check that advanced content isn't mixed in with beginner-facing pages.
76
77
-**Forward navigation path**: A reader should be able to follow "Next steps" links from the quickstart through core workflows without relying on the sidebar.
@@ -147,6 +148,7 @@ Structure your review as:
147
148
Before finalizing your review, verify:
148
149
149
150
-[ ] Did you check related documents for duplication or misplaced content?
151
+
-[ ] For new pages: did you check for sufficient inbound links from related pages (intros, overviews, feature lists)?
150
152
-[ ] Did you verify content belongs in the right document?
151
153
-[ ] Did you check for a project style guide?
152
154
-[ ] Are your recommendations actionable (not just "this is bad")?
0 commit comments