Skip to content

Conversation

@shtse8
Copy link
Contributor

@shtse8 shtse8 commented Dec 10, 2025

Summary

Complete VitePress documentation site for CodeRAG with:

Documentation Structure

  • Guide Section (12 pages): Getting started, installation, quick start, how search works, AST chunking, TF-IDF, vector search, hybrid search, storage, file watching, languages, performance
  • API Reference (7 pages): Overview, CodebaseIndexer, PersistentStorage, search functions, embedding providers, AST chunking, TypeScript types
  • MCP Server (5 pages): Overview, installation, configuration, tools reference, IDE integration

Features

  • Full SEO/OG meta tags for social sharing
  • SVG icons (replaced emojis for cleaner look)
  • Sitemap generation
  • Local search
  • Dark/light mode
  • Edit on GitHub links

LLM Integration

  • context7.json - For Context7 MCP documentation discovery
  • llms.txt - Standard format for AI assistant context

Assets

  • Updated logo (SVG)
  • OG image for social sharing

Test plan

  • bun run docs:build passes
  • Preview deployment looks correct
  • All links work
  • Search works locally

- Add complete guide section (getting-started, installation, quick-start,
  how-search-works, ast-chunking, tfidf, vector-search, hybrid-search,
  storage, file-watching, languages, performance)
- Add API reference section (overview, indexer, storage, search,
  embeddings, chunking, types)
- Add MCP server section (overview, installation, configuration,
  tools, ide-integration)
- Configure SEO/OG tags for social sharing
- Add context7.json for LLM documentation discovery
- Add llms.txt for AI assistant context
- Update home page with SVG icons (replacing emojis)
- Add logo and OG image assets
- Fix build issues with HTML-like syntax in headings
@vercel
Copy link

vercel bot commented Dec 10, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
coderag Ready Ready Preview Comment Dec 10, 2025 7:07pm
coderag-j1ok Ready Ready Preview Comment Dec 10, 2025 7:07pm

@shtse8 shtse8 merged commit 00c8580 into main Dec 10, 2025
7 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.

2 participants