Skip to content

Commit bf2f444

Browse files
danbarrclaude
andcommitted
Address review feedback: restore Diataxis, fix paths
- Restore Diataxis framework reference as the underlying authoring model (it still applies, just not to folder structure) - Remove reference to transient restructuring plan document - Add docs/toolhive/ base path to all folder references so contributors place files correctly Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8550cb9 commit bf2f444

3 files changed

Lines changed: 11 additions & 9 deletions

File tree

.claude/skills/docs-review/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ Watch for these telltale signs of AI-generated docs that need human intervention
6565

6666
### Section Structure and Navigation
6767

68-
The docs follow a product-area-based information architecture. Check:
68+
The docs follow a product-area-based information architecture under `docs/toolhive/`. Check:
6969

70-
- **Self-contained sections**: Product-specific content belongs in its product section (`guides-ui/`, `guides-cli/`, `guides-k8s/`, `guides-vmcp/`, `guides-registry/`), not in a shared section.
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.
7171
- **Quickstarts in product sections**: Quickstarts live inside their product section, not in a separate top-level section.
7272
- **Integration placement**: Third-party integration guides (ngrok, Vault, OpenTelemetry, Okta, etc.) belong in `integrations/`, not in a product section.
7373
- **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.

.claude/skills/upstream-release-docs/SKILL.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ Apply the approved changes:
124124

125125
2. **Create new pages** for new features that lack existing documentation. Default to documenting new features rather than skipping them:
126126

127-
**Page placement** — the docs are organized by product area. Place new content in the correct section:
128-
- **Product-specific guides** go in the relevant product section (`guides-ui/`, `guides-cli/`, `guides-k8s/`, `guides-vmcp/`, `guides-registry/`).
129-
- **Third-party integration guides** go in `integrations/`.
130-
- **Cross-cutting concepts** go in `concepts/`.
131-
- **Per-MCP-server usage guides** go in `guides-mcp/`.
132-
- **Reference material** goes in `reference/`.
127+
**Page placement** — the docs are organized by product area under `docs/toolhive/`. Place new content in the correct section:
128+
- **Product-specific guides** go in the relevant product section (`docs/toolhive/guides-ui/`, `guides-cli/`, `guides-k8s/`, `guides-vmcp/`, `guides-registry/`).
129+
- **Third-party integration guides** go in `docs/toolhive/integrations/`.
130+
- **Cross-cutting concepts** go in `docs/toolhive/concepts/`.
131+
- **Per-MCP-server usage guides** go in `docs/toolhive/guides-mcp/`.
132+
- **Reference material** goes in `docs/toolhive/reference/`.
133133
- Check the project's CLAUDE.md "Information architecture" section for the full placement rules.
134134

135135
**Diataxis separation** — create separate pages per document type, not one combined page:

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ The documentation should be accessible to a wide range of technical users, inclu
8080

8181
## Information architecture
8282

83-
The docs are organized by **product area**, with each section self-contained so a reader can complete their journey without leaving it. Cross-cutting content lives in dedicated shared sections. The authoritative restructuring plan is in `/docs-restructuring/1-docs-restructuring-plan.md`.
83+
This project follows the [Diataxis framework](https://diataxis.fr/) for documentation authoring - each page is a tutorial, how-to guide, reference, or explanation. The site is organized by **product area**, with each section self-contained so a reader can complete their journey without leaving it. Cross-cutting content lives in dedicated shared sections.
84+
85+
All documentation lives under `docs/toolhive/`. Folder paths below are relative to that root.
8486

8587
### Design principles
8688

0 commit comments

Comments
 (0)