Skip to content

Reorganize documentation structure for events and controller - #68

Merged
oblomov-dev merged 8 commits into
mainfrom
claude/split-event-page-sections-9drDr
May 20, 2026
Merged

Reorganize documentation structure for events and controller#68
oblomov-dev merged 8 commits into
mainfrom
claude/split-event-page-sections-9drDr

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

Summary

Restructured the documentation to improve organization and clarity by splitting monolithic pages into focused, topic-specific pages and reorganizing the navigation hierarchy.

Key Changes

Documentation Reorganization

  • Events section: Split docs/development/events/backend.md into three focused pages:

    • backend.md - Backend event handling with client->_event
    • frontend.md - Frontend events with client->_event_client
    • follow_up.md - Follow-up actions after backend processing
  • Controller section: Expanded from single page to four focused pages:

    • life_cycle.md - Overall request lifecycle pattern (renamed from general.md)
    • init.md - Initialization with client->check_on_init
    • event.md - Event handling with client->check_on_event
    • navigated.md - Navigation returns with client->check_on_navigated
  • Navigation section: Reorganized navigation.md:

    • Created inner_cross_app.md with cross-app and inner app navigation content
    • Moved Launchpad cross-app navigation guidance to docs/configuration/launchpad.md

Navigation Structure Updates

  • Updated .vitepress/config.mjs to reflect new document hierarchy:
    • Controller now has collapsible submenu with Life Cycle, Init, Event, Navigated
    • Events now has collapsible submenu with Backend, Frontend, Follow-up
    • Navigation links to new inner_cross_app.md page
    • Reorganized "Specific" section with new "More" submenu for Demo Output
    • Updated several menu labels for clarity (e.g., "Productive Usage" → "Production Use")

Content Refinements

  • Simplified life_cycle.md to focus on the overall pattern without full method implementations
  • Removed redundant content from navigation.md (moved to dedicated pages)
  • Enhanced launchpad.md with cross-app navigation section
  • Improved heading hierarchy (changed #### to ## for consistency)

Benefits

  • Better information architecture with focused, single-topic pages
  • Improved discoverability through expanded navigation menu
  • Clearer separation of concerns (init vs event vs navigation handling)
  • Easier maintenance and future updates to specific topics

https://claude.ai/code/session_01D8HH1LFgyVeWWk1SgieRmV

@oblomov-dev
oblomov-dev merged commit bc01c27 into main May 20, 2026
@oblomov-dev
oblomov-dev deleted the claude/split-event-page-sections-9drDr branch May 20, 2026 13:44
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