Skip to content

docs: improve documentation for launch readiness#35

Merged
rprabhat merged 1 commit into
mainfrom
docs/improve-launch-readiness
Apr 7, 2026
Merged

docs: improve documentation for launch readiness#35
rprabhat merged 1 commit into
mainfrom
docs/improve-launch-readiness

Conversation

@rprabhat

@rprabhat rprabhat commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Major documentation improvements for both user audiences:

  • Add "Local-First Personal App" section for non-technical users who want to explore their documents
  • Add "AI Agent Memory" section for technical users who want to use as knowledge base
  • Fix CLI naming inconsistency (nexus vs sensibledb)
  • Mark MCP as Coming Soon (feature not yet implemented)
  • Mark TypeScript/Python SDKs as Coming Soon (not published to npm/pypi)
  • Fix CLI install URL (source build is the working method)
  • Fix broken links
  • Update mkdocs navigation with audience-based sections

Key Changes

For Non-Technical Users

  • 100% Local-First messaging (data never leaves computer)
  • Works Offline
  • "Download, Connect, Use" - simple Explorer UI flow

For Technical Users

  • CLI + HTTP for now (SDKs coming soon)
  • MCP Server Coming Soon
  • Embedded Mode for full Rust integration
  • No external LLM calls needed

Testing

- Add local-first personal app section for non-technical users
- Add technical user section for AI agent memory use case
- Fix CLI naming (nexus vs sensibledb) consistency
- Mark MCP as Coming Soon
- Mark TypeScript/Python SDKs as Coming Soon (not yet published)
- Fix CLI install URL (source build as primary method)
- Fix broken links in 5-minutes.md
- Update mkdocs nav with audience sections
- Update SDK docs with correct import and status
@rprabhat rprabhat merged commit 6bf86cd into main Apr 7, 2026
7 checks passed
@rprabhat rprabhat deleted the docs/improve-launch-readiness branch April 7, 2026 04:06
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