Skip to content

Improve and Complete Documentation Content #48

@zTgx

Description

@zTgx

The documentation site (vectorless.dev) is currently minimal — only a single intro page and one blog post. This issue tracks the overall effort to expand it into comprehensive, well-structured documentation.

Current State

  • Site infrastructure (Docusaurus, custom theme, navbar)
  • Intro page with Quick Start (Python + Rust)

TODO

  • Concepts & Architecture — How Vectorless works (hierarchical semantic trees, reasoning-native retrieval, no vectors/embeddings)
  • Configuration Guide — LLM provider setup, workspace, indexing options, retrieval strategies
  • API Reference — Public API for both Python and Rust (indexing, querying, workspace management)
  • Examples & Tutorials — End-to-end walkthroughs (PDF indexing, multi-document queries, custom retrieval strategies)
  • Deployment & Integration — Using Vectorless in production, integrating with frameworks
  • Contributing Guide — Development setup, code conventions, PR process
  • Blog Content — Technical deep-dives, use cases, release notes

Notes

The sidebar (sidebars.ts) currently uses auto-generation. It should be updated to a manual structure once the page hierarchy is defined.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions