Reorganize troubleshooting docs and restructure sidebar navigation - #91
Merged
Conversation
…e Modes section from exception.md
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.
Summary
This PR refactors the documentation structure by extracting common failure scenarios into a dedicated troubleshooting guide and reorganizing the sidebar navigation for better discoverability.
Key Changes
New troubleshooting guide: Created
docs/cookbook/troubleshooting/common_failures.mddocumenting three frequent failure modes:Content migration: Moved the "Common Failure Modes" section from
docs/cookbook/event_navigation/exception.mdto the new dedicated page, reducing duplication and improving organizationUpdated cross-references: Modified
exception.mdto link to the new Common Failures page instead of embedding the content inlineSidebar restructuring (
docs/.vitepress/config.mjs):Implementation Details
The troubleshooting content maintains the same technical depth and examples while being more discoverable through dedicated documentation. The sidebar changes improve information architecture by grouping related topics and reducing cognitive load in the Configuration section.
https://claude.ai/code/session_01VxknFMLKaNS1oQRMq7vrCG