Skip to content

docs(website): add comprehensive documentation site#168

Merged
diranged merged 3 commits intomainfrom
feature/comprehensive-docs
Feb 26, 2026
Merged

docs(website): add comprehensive documentation site#168
diranged merged 3 commits intomainfrom
feature/comprehensive-docs

Conversation

@diranged
Copy link
Contributor

Summary

  • Adds complete Hugo + Docsy documentation site under website/content/en/docs/
  • 13 documentation pages covering getting started, concepts, reference, troubleshooting, and development
  • Content migrated from existing README.md, ALGORITHM.md, DEVELOPMENT.md, DEBUG.md, and package READMEs

Pages Created

  • Getting Started: Installation guide with Helm, IAM setup, verification
  • Concepts: Architecture overview, cost calculation algorithms (from ALGORITHM.md)
  • Reference: Configuration, metrics catalog with PromQL examples, Helm chart values, debug endpoints
  • Troubleshooting: Common issues and debugging scenarios
  • Development: Local setup, testing, contributing guidelines

Test plan

  • hugo --minify builds successfully with 21 pages, 0 errors
  • Review rendered pages in browser (hugo server)
  • Verify all cross-references resolve correctly
  • Check content accuracy against source files

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>
@diranged diranged marked this pull request as ready for review February 26, 2026 20:37
@diranged diranged merged commit eb521de into main Feb 26, 2026
4 checks passed
@diranged diranged deleted the feature/comprehensive-docs branch February 26, 2026 20:37
@diranged diranged restored the feature/comprehensive-docs branch February 26, 2026 20:39
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