Skip to content

docs: compress 55 docs into 5 pages#108

Merged
stephenc222 merged 4 commits into
mainfrom
docs/compress-to-five-pages
Jun 22, 2026
Merged

docs: compress 55 docs into 5 pages#108
stephenc222 merged 4 commits into
mainfrom
docs/compress-to-five-pages

Conversation

@stephenc222

Copy link
Copy Markdown
Contributor

Summary

  • Replaces ~55 scattered docs files with 5 focused pages: quickstart.md, USAGE.md, REFERENCE.md, ARCHITECTURE.md, CONTRIBUTING.md
  • Updates docs/.vitepress/config.js nav/sidebar to the new structure; restores docs/index.md home page
  • Adds a new quickstart.md — install, sample output, LRS table, GitHub Action snippet, links to deeper docs
  • Fixes two doc inaccuracies found during audit: net-repo-regression is warning-only (not blocking), and hotspots diff exit code 2 (auto-analysis failed) was undocumented

Test plan

  • VitePress site builds without errors (cd docs && npm run build)
  • Nav links resolve: Quick Start, Usage, Reference, Architecture, Contributing
  • Home page hero "Get Started" → quickstart page
  • No broken sidebar links

🤖 Generated with Claude Code

@stephenc222 stephenc222 merged commit 7974c41 into main Jun 22, 2026
8 checks passed
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