Add comprehensive bilingual documentation system with live views

[cmbaldwin]

Summary

This PR introduces a complete end-user documentation system for Oroshi, transforming the codebase from having only developer-facing docs to providing rich, bilingual (Japanese/English) user guides. Documentation is served as live Rails views rather than static files, enabling automatic screenshot capture, cross-references, and maintainability.

Key Changes

• Documentation Controller & Routes: Added Oroshi::DocumentationController with routes for index, section, and page views. Supports locale switching via URL parameters.

• Bilingual Content: Created comprehensive i18n locale files (documentation.ja.yml, documentation.en.yml) covering 7 sections with 30+ pages of user-facing documentation.

• Documentation Views: Built 30+ ERB templates organized by section (Getting Started, Orders, Supply Chain, Production, Shipping, Financials, Admin) with consistent layout and navigation.

• Documentation Layout: New dedicated documentation.html.erb layout with:

  • Collapsible sidebar navigation
  • Breadcrumb trails
  • Language toggle (日本語/English)
  • Client-side full-text search via Stimulus controller
  • Responsive design for desktop and tablet

• Helper Methods: Added DocumentationHelper with utilities for:

  • doc_link_to() — bilingual documentation links
  • doc_see_also() — cross-reference lists
  • documentation_help_link() — contextual help icons from main app

• Stimulus Controllers:

  • documentation_search_controller.js — Real-time search across documentation pages
  • documentation_diagram_controller.js — Client-side Mermaid.js diagram rendering

• Testing Infrastructure:

  • DocumentationControllerTest — Verifies all pages render in both locales
  • DocumentationI18nTest — Validates translation completeness
  • docs.rake — Verification tasks for view files, locale keys, and cross-references

• Navigation Integration: Added documentation link to main navbar and help icons to key pages (Orders, Supplies, Materials, Payments, Invoices).

Implementation Details

• Documentation is served from authenticated routes (accessible to all logged-in users)
• All content is i18n-driven, enabling seamless language switching
• Views use consistent helper methods for cross-references and navigation
• Locale files are fully structured with keys for all sections, pages, and UI chrome
• Verification rake task ensures documentation integrity (view files exist, all locale keys present, cross-references valid)
• Screenshots can be captured via system tests and stored in app/assets/images/docs/

Files Added

• app/controllers/oroshi/documentation_controller.rb
• app/helpers/oroshi/documentation_helper.rb
• app/views/layouts/documentation.html.erb
• app/views/oroshi/documentation/ — 30+ view templates
• app/javascript/controllers/documentation_*.js — 2 Stimulus controllers
• config/locales/documentation.{ja,en}.yml — Bilingual content
• lib/tasks/docs.rake — Verification and maintenance tasks
• test/controllers/oroshi/documentation_controller_test.rb
• test/i18n/documentation_i18n_test.rb

Files Modified

• config/routes.rb — Added documentation routes
• app/views/layouts/shared/_navbar.html.erb — Added documentation link
• app/views/oroshi/orders/index.html.erb — Added help link
• app/views/oroshi/orders/search.html.erb — Added help link
• app/views/oroshi/supplies/index.html.erb — Added help link
• app/views/oroshi/payment_receipts/index.html.erb — Added help link
• app/views/oroshi/materials/index.html.erb — Added help link
• app/views/oroshi/dashboard/index.html.erb — Minor layout adjustment
• app/views/oroshi/dashboard/_home.html.erb — Minor layout adjustment
• `app/views/oroshi/invoices/index.html

https://claude.ai/code/session_01BRR9VwvNKS1p7sPJKUt1Rb