Skip to content

Reorganize troubleshooting docs and restructure sidebar navigation - #91

Merged
oblomov-dev merged 5 commits into
mainfrom
claude/modest-goldberg-MtbLK
May 23, 2026
Merged

Reorganize troubleshooting docs and restructure sidebar navigation#91
oblomov-dev merged 5 commits into
mainfrom
claude/modest-goldberg-MtbLK

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

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.md documenting three frequent failure modes:

    • Binding-path mismatches and how to debug them in the browser console and network tab
    • Malformed XML parsing errors and their various manifestations
    • Guidance on where to look for silent failures that don't raise ABAP exceptions
  • Content migration: Moved the "Common Failure Modes" section from docs/cookbook/event_navigation/exception.md to the new dedicated page, reducing duplication and improving organization

  • Updated cross-references: Modified exception.md to link to the new Common Failures page instead of embedding the content inline

  • Sidebar restructuring (docs/.vitepress/config.mjs):

    • Grouped Quickstart-related pages (Installation, Hello World, Full Example) under a collapsible "Quickstart" submenu
    • Created new "Troubleshooting" section in the Cookbook with links to both Debugging and Common Failures pages
    • Moved "Debugging" link from Configuration section to the new Troubleshooting subsection
    • Renamed "Advanced Features" to "Advanced" for consistency

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

@oblomov-dev
oblomov-dev merged commit 02eb496 into main May 23, 2026
@oblomov-dev
oblomov-dev deleted the claude/modest-goldberg-MtbLK branch May 23, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants