Restructure documentation using Diataxis framework#94
Open
MiguelsPizza wants to merge 4 commits intomainfrom
Open
Restructure documentation using Diataxis framework#94MiguelsPizza wants to merge 4 commits intomainfrom
MiguelsPizza wants to merge 4 commits intomainfrom
Conversation
Implement the Diataxis documentation framework to improve content organization and user experience: **New Tutorials (/tutorials/)** - Add "Your First Tool (React)" - step-by-step tutorial - Add "Your First Tool (Vanilla JS)" - alternative path - Focus on ONE path per tutorial, no alternatives **New How-to Guides (/how-to/)** - Design Effective Tools - naming, descriptions, consolidation - Handle Errors - auth checks, network failures, validation - Validate Input - Zod and JSON Schema patterns - Format Responses - markdown over JSON - Optimize Performance - optimistic updates, caching - Test Your Tools - unit testing and extension testing **Navigation restructure (docs.json)** - Add "Tutorials" group with graduation-cap icon - Rename "Guides" to "How-to Guides" with wrench icon - Rename "NPM Packages" to "API Reference" - Rename "Reference" to "Resources" - Reorganize Concepts tab for clarity **Content updates** - Update concepts/overview.mdx with better entry point - Update best-practices.mdx to hub linking to how-to guides - Add Diataxis guidelines to CLAUDE.md The Diataxis framework separates documentation into four types: - Tutorials: Learning by doing - How-to Guides: Solving specific problems - Reference: Looking up facts - Explanation: Understanding concepts This prevents content mixing and helps users find the right type of documentation for their needs.
Reorder tutorials to present vanilla JS first as the recommended starting point - simpler with no framework dependencies.
Leave this file unchanged to avoid conflicts with the Concepts tab restructure work happening in parallel.
Leave Concepts tab navigation unchanged - another task is handling the full Concepts tab restructure.
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
2 participants
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.
Implement the Diataxis documentation framework to improve content organization and user experience:
New Tutorials (/tutorials/)
New How-to Guides (/how-to/)
Navigation restructure (docs.json)
Content updates
The Diataxis framework separates documentation into four types:
This prevents content mixing and helps users find the right type of documentation for their needs.