Skip to content

feat: add multilingual user manual

Laxman Reddy requested to merge feat/corpus-user-manual into develop

Description:

Implemented a complete multilingual User Manual system for Corpus with improved navigation, localization, and documentation structure.

Major Changes:

  • Added dedicated User Manual access below the Login button.
  • Removed old top-right help icon behavior.
  • Implemented grouped/collapsible sidebar navigation.
  • Added structured documentation sections for:
    • Home Page
    • Upload System
    • Tools & Review System
    • Profile & Dashboard
  • Added detailed Profile Dashboard documentation:
    • Activity Map
    • Contribution Statistics
    • Metadata Editing
    • Contribution Records
    • Geographical Contribution Map
  • Implemented multilingual localization support:
    • English
    • Telugu
    • Hindi
    • Kannada
    • Tamil
    • Bengali
    • Malayalam
  • Added translation architecture using locale-based files.
  • Added User Manual back navigation.
  • Fixed duplicate numbering and sidebar inconsistencies.
  • Added responsive mobile support for manual navigation.
  • Added screenshots and media placeholders for documentation sections.
  • Improved overall UI/UX consistency and navigation flow.

Type of Change:

  • Feature Development
    • Documentation
    • Bug Fix

Testing:

  • Tested on desktop
    • Tested on mobile
    • Tested in different browsers

Verified:

  • Sidebar expand/collapse behavior
  • Manual section navigation
  • Language switching
  • Localization fallback handling
  • Responsive layout
  • User Manual routing
  • Back button navigation
  • Translation rendering
  • Profile Dashboard sections
  • Login page manual access

Screenshots (if applicable):

Added screenshots for:

  • Login Page
  • Signup
  • Upload System
  • Live Upload Features
  • Profile Dashboard
  • Peer Review
  • Image Annotation
  • Audio Tool
  • Video Tool
  • Document Digitization
  • Network Checking
  • User Preferences

Video Demo:

Add PR demo video link here.

If AI-assisted implementation was used, attach a walkthrough video explaining:

  • Localization system
  • Sidebar grouping
  • Manual architecture
  • Translation flow
  • Navigation behavior

Checklist:

  • Code follows project style guidelines
    • Self-review completed
    • No console errors
    • TypeScript types are correct

Merge request reports

Loading