Skip to content

docs(website): improve design and consolidate documentation#169

Draft
diranged wants to merge 3 commits intomainfrom
feature/comprehensive-docs
Draft

docs(website): improve design and consolidate documentation#169
diranged wants to merge 3 commits intomainfrom
feature/comprehensive-docs

Conversation

@diranged
Copy link
Contributor

Summary

  • Fix broken card shortcodes on docs hub, rewrite with Mermaid diagrams
  • Enrich sparse section landing pages with overview content
  • Add Mermaid architecture and cost calculation flowcharts
  • Enable search, breadcrumbs, foldable sidebar
  • Add Get Started CTA to landing page
  • Fix troubleshooting ToC granularity, add cross-links
  • Add metrics summary table, improve footer
  • Consolidate standalone docs (ALGORITHM.md, DEVELOPMENT.md, DEBUG.md, etc.) to redirect stubs pointing to the Hugo site as single source of truth
  • Add website README with local dev instructions

Test plan

  • cd website && hugo --minify builds with no errors
  • All pages render correctly with working navigation
  • Mermaid diagrams render on docs hub, architecture, and cost calculation pages
  • Search works
  • Redirect stubs in standalone docs point to correct Hugo pages

🤖 Generated with Claude Code

diranged and others added 3 commits February 26, 2026 11:03
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Fix broken card shortcodes on docs hub, rewrite with Mermaid diagram
- Enrich sparse section landing pages with overview content
- Add Mermaid architecture and cost calculation flowcharts
- Enable search, breadcrumbs, foldable sidebar
- Add Get Started CTA to landing page
- Fix troubleshooting ToC granularity, add cross-links
- Add metrics summary table, improve footer
- Add website README with local dev instructions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Shrink README.md to a brief overview pointing to the docs site.
Replace standalone doc files (ALGORITHM.md, DEVELOPMENT.md, DEBUG.md,
pkg/config/README.md, pkg/metrics/README.md) with redirect notices
to their Hugo equivalents. The Hugo site at oss.nextdoor.com/lumina
is now the single source of truth.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant