-
Notifications
You must be signed in to change notification settings - Fork 0
feat: embed MkDocs build output in React web dashboard at /docs #295
Copy link
Copy link
Closed
Labels
prio:lowNice to have, can deferNice to have, can deferscope:medium1-3 days of work1-3 days of worktype:featureNew feature implementationNew feature implementationv0.5Minor version v0.5Minor version v0.5v0.5.4Patch release v0.5.4Patch release v0.5.4
Description
Summary
Serve the MkDocs documentation inside the React web dashboard at /docs, using the build output embedding strategy (ADR-003).
Tasks
- Add nginx location block in
docker/web/config:location /docs/ { alias /usr/share/nginx/html/docs/; try_files $uri $uri/ /docs/index.html; }
- Update Docker CI to copy MkDocs build output into web image's
/docs/directory - Customize MkDocs Material theme colors/fonts to align with dashboard design system
- Add "Documentation" link in React app navigation pointing to
/docs/ - Exclude
/docs/*from React Router SPA routing
Notes
- The docs are served as static HTML by nginx, bypassing React Router entirely
- MkDocs Material's search, navigation, and dark mode all work as-is
- Styling consistency: customize Material theme CSS variables to match dashboard palette
- See ADR-003 for architecture rationale
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
prio:lowNice to have, can deferNice to have, can deferscope:medium1-3 days of work1-3 days of worktype:featureNew feature implementationNew feature implementationv0.5Minor version v0.5Minor version v0.5v0.5.4Patch release v0.5.4Patch release v0.5.4