Update guidance files for docs restructuring#644
Merged
Conversation
Update AGENTS.md/CLAUDE.md, STYLE-GUIDE.md, and skills (docs-review, upstream-release-docs) to encode the information architecture, design principles, and page conventions established during the Phase 1-3 docs restructuring. This ensures future contributions follow the new product-area-based structure. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor and AI guidance to align documentation authoring/review workflows with the new product-area-based information architecture from the Phase 1–3 docs restructuring.
Changes:
- Adds a “Page structure” section to the style guide (front matter, “Next steps”, intro pages, cross-references).
- Replaces Diataxis-focused IA guidance in AGENTS.md with product-area sections, design principles, and placement/page requirements.
- Updates
.claudeskills (docs-review, upstream-release-docs) checklists to enforce placement rules and “Next steps”.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| STYLE-GUIDE.md | Adds page-structure conventions (front matter, “Next steps”, intro pages, cross-links). |
| AGENTS.md | Replaces IA guidance with product-area structure, placement rules, and page requirements. |
| .claude/skills/upstream-release-docs/SKILL.md | Adds product-area page placement rules + “Next steps” checklist item. |
| .claude/skills/docs-review/SKILL.md | Adds IA/navigation checklist emphasizing correct section placement and “Next steps”. |
- 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>
rdimitrov
approved these changes
Mar 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updates project guidance files (AGENTS.md/CLAUDE.md, STYLE-GUIDE.md) and skills (docs-review, upstream-release-docs) to reflect the information architecture established during the Phase 1-3 docs restructuring. This ensures future contributions - both human and AI-assisted - follow the new product-area-based structure.
AGENTS.md / CLAUDE.md (symlinked):
STYLE-GUIDE.md:
example, Introduction page pattern, cross-reference patterns
docs-review skill:
upstream-release-docs skill:
Type of change
Related issues/PRs
Follow-up to the Phase 1-3 docs restructuring work.
Submitter checklist
Content and formatting
🤖 Generated with Claude Code