Skip to main content
Last Updated: 2025-01-25
Status: Active
Navigation Documentation Index: For an overview of all navigation documentation, see NAVIGATION_GUIDE_INDEX.md
Navigation Standard: For complete navigation standards and policies, see NAVIGATION_STANDARD.md
Quick Start: This document provides step-by-step implementation tasks for navigation improvements and quick lookup reference.

Phase 1: Foundation (Weeks 1-2)

Task 1.1: Add Sub-Module Visual Indicators (Desktop)

File: src/platform/navigation/components/InModuleSidebar.tsx Changes:
1
  • Add visual badge/indicator for sub-module groups
  • Show sub-module description on hover
  • Style sub-module groups differently
  • Implementation:
    Acceptance Criteria:
    • Sub-modules have visual indicator in desktop sidebar
    • Description shows on hover/focus
    • Visual distinction is clear but not overwhelming

    Task 1.2: Enhance Mobile Menu Sheet for Sub-Modules

    File: src/platform/navigation/MobileMenuSheet.tsx Changes:
    1
  • Show sub-modules prominently in module section
  • Add sub-module quick actions
  • Improve sub-module context display
  • Implementation:
    Acceptance Criteria:
    • Sub-modules visible in mobile menu
    • Quick actions accessible
    • Clear parent-child relationship

    Task 1.3: Document Navigation Standards

    File: docs/architecture/MODULE_NAVIGATION_STANDARD.md Changes:
    1
  • Add navigation pattern decision tree
  • Document when to use navItems vs. navGroups vs. sub-modules
  • Add visual examples
  • Acceptance Criteria:
    • Decision tree documented
    • Examples for each pattern
    • Guidelines for module creators

    Phase 2: HR Optimization (Weeks 3-4)

    Task 2.1: Make HR Groups Collapsible with Smart Defaults

    File: src/platform/navigation/components/InModuleSidebar.tsx Changes:
    1
  • Make all HR groups collapsible (not just 5+)
  • Default: Open “People Management” and current sub-module
  • Remember collapsed state per user
  • Implementation:
    Acceptance Criteria:
    • All HR groups are collapsible
    • Smart defaults work correctly
    • State persists per user (future: localStorage)

    Task 2.2: Add Sub-Module Quick Actions to HR Overview

    File: src/platform/navigation/components/InModuleSidebar.tsx Changes:
    1
  • Show sub-module quick actions in group header
  • Add module-level quick actions section
  • Make quick actions accessible from parent view
  • Implementation:
    Acceptance Criteria:
    • Quick actions visible in group header
    • Quick actions work correctly
    • Mobile-friendly touch targets

    Task 2.3: Improve Mobile Sub-Module Discovery

    File: src/platform/navigation/MobileMenuSheet.tsx Changes:
    1
  • Add “Enter Sub-Module” buttons in mobile menu
  • Show sub-module preview cards
  • Improve sub-module context in header
  • Implementation:
    Acceptance Criteria:
    • Sub-modules discoverable in mobile menu
    • Clear entry points
    • Preview information helpful

    Task 2.4: Add HR Sub-Module to Mobile Bottom Nav Config

    File: src/platform/navigation/mobile-nav-config.ts Changes:
    1
  • Add HR sub-module shortcuts to available shortcuts
  • Allow users to customize which sub-module appears
  • Update default shortcuts if needed
  • Implementation:
    Acceptance Criteria:
    • HR sub-modules available in bottom nav config
    • Users can customize
    • Permissions respected

    Phase 3: Cross-Module Consistency (Weeks 5-6)

    Task 3.1: Update Module Flyout for Sub-Modules

    File: src/platform/navigation/components/ModuleFlyout.tsx Changes:
    1
  • Show sub-modules with visual distinction
  • Include sub-module quick actions
  • Add “Enter Sub-Module” action
  • Implementation:
    Acceptance Criteria:
    • Sub-modules visible in flyout
    • Quick actions accessible
    • Visual distinction clear

    Task 3.2: Standardize Mobile Menu Sheet

    File: src/platform/navigation/MobileMenuSheet.tsx Changes:
    1
  • Consistent layout for all modules
  • Sub-module section standardized
  • Improved search includes sub-modules
  • Implementation:
    Acceptance Criteria:
    • Consistent layout across modules
    • Sub-modules always visible when present
    • Search works for sub-modules

    Task 3.3: Review and Align All Modules

    Files: src/platform/modules/module-registry.ts (all modules) Changes:
    1
  • Review each module against standards
  • Align navigation patterns
  • Ensure consistency
  • Checklist per Module:
    • Uses appropriate pattern (navItems vs. navGroups vs. sub-modules)
    • Groups are logical and scannable
    • Sub-modules have overviewRoute and quickActions
    • Permissions are correct
    • Mobile shortcuts configured (if applicable)
    Modules to Review:
    • HR (already optimized in Phase 2)
    • RH
    • FA
    • FW
    • LO
    • FM
    • GR

    Phase 4: Advanced Features (Weeks 7-8)

    Task 4.1: Navigation Customization UI

    File: src/platform/navigation/components/NavigationCustomizer.tsx (new) Changes:
    1
  • Create navigation customization component
  • Allow pinning favorite sub-modules
  • Customize group order
  • Hide unused groups
  • Implementation:
    Acceptance Criteria:
    • Users can customize navigation
    • Preferences persist
    • Mobile and desktop supported

    Task 4.2: Enhance Global Search with Sub-Modules

    File: src/platform/navigation/components/GlobalSearch.tsx (or create new) Changes:
    1
  • Include sub-modules in search results
  • Show sub-module context in results
  • Quick navigation to sub-modules
  • Implementation:
    Acceptance Criteria:
    • Sub-modules appear in search
    • Context is clear
    • Navigation works correctly

    Task 4.3: Usage Analytics Integration

    File: src/platform/navigation/hooks/useNavigationAnalytics.ts (new) Changes:
    1
  • Track navigation usage
  • Identify pain points
  • Create analytics dashboard
  • Implementation:
    Acceptance Criteria:
    • Navigation events tracked
    • Analytics dashboard created
    • Privacy-compliant (no PHI)

    Testing Checklist

    Desktop Testing

    • All modules render correctly
    • Sub-modules have visual indicators
    • Collapsible groups work
    • Quick actions accessible
    • Keyboard navigation works
    • Screen reader compatible

    Mobile Testing

    • Mobile menu shows sub-modules
    • Touch targets meet 44px minimum
    • Sub-module navigation works
    • Breadcrumbs display correctly
    • Bottom nav customizable
    • Safe area insets respected

    Cross-Module Testing

    • All modules follow standards
    • Navigation patterns consistent
    • Permissions respected
    • Performance acceptable

    Rollout Strategy

    Phase 1 Rollout

    1
  • Deploy to staging
  • Internal testing (1 week)
  • Beta users (1 week)
  • Production release
  • Phase 2 Rollout

    1
  • Deploy HR improvements to staging
  • HR team testing (1 week)
  • All users (gradual rollout)
  • Phase 3 Rollout

    1
  • Deploy all module improvements
  • User communication
  • Training materials
  • Support documentation
  • Phase 4 Rollout

    1
  • Feature flags for customization
  • Opt-in beta
  • Gradual rollout
  • Analytics monitoring

  • Success Criteria

    Phase 1

    • Sub-modules visually distinct
    • Mobile menu improved
    • Standards documented

    Phase 2

    • HR navigation optimized
    • User feedback positive
    • No regression in other modules

    Phase 3

    • All modules consistent
    • Navigation patterns standardized
    • User experience improved

    Phase 4

    • Customization available
    • Search enhanced
    • Analytics providing insights

    Support & Documentation

    User Documentation

    • Navigation guide for users
    • Sub-module explanation
    • Customization tutorial
    • FAQ updates

    Developer Documentation

    • Navigation standards updated
    • Module creation guide
    • Sub-module implementation guide
    • API documentation

    Training Materials

    • Video tutorials
    • Screenshots
    • Step-by-step guides
    • Best practices

    Quick Reference Status: Ready for Implementation
    Next Review: After Phase 1 completion