Skip to content

docs: add source ranking to build and deploy docs#964

Open
KolaSailaja wants to merge 2 commits into
imDarshanGK:mainfrom
KolaSailaja:docs/source-ranking-build-deploy
Open

docs: add source ranking to build and deploy docs#964
KolaSailaja wants to merge 2 commits into
imDarshanGK:mainfrom
KolaSailaja:docs/source-ranking-build-deploy

Conversation

@KolaSailaja

Copy link
Copy Markdown

📌 Related Issue

Fixes #923


📝 Description

This PR improves the build and deployment documentation by adding a dedicated section explaining RAG source ranking in LocalMind.

The documentation now covers:

  • How retrieved document chunks are ranked using ChromaDB cosine similarity.
  • How ranked chunks are used to generate document citations.
  • The retrieval-related configuration options that influence source selection (rag_top_k and rag_chunk_overlap).
  • Production considerations for configuring source retrieval while deploying LocalMind.

The changes are limited to the project documentation and do not modify any application code.


📂 Files Changed

  • README.md

✅ Testing

  • Verified Markdown formatting and heading hierarchy.
  • Confirmed documentation is consistent with the existing repository structure.
  • No code changes were introduced.

📸 Screenshots

N/A (Documentation-only change)


✔️ Checklist

  • Documentation updated.
  • No application code changed.
  • Followed the existing documentation style.
  • Kept the changes minimal to reduce merge conflicts.
  • Verified Markdown formatting.
  • Ready for review.

@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

@KolaSailaja is attempting to deploy a commit to the Darshan's projects Team on Vercel.

A member of the Team first needs to authorize it.

@KolaSailaja

Copy link
Copy Markdown
Author

@imDarshanGK Could you please review this pr and help me with the feedback about any changes needed

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KolaSailaja Thanks for the contribution! This PR doesn't match Issue #923. The issue is about updating the build and deploy documentation, but this PR adds documentation for RAG source ranking in the README. Please update the relevant build/deploy docs or link this PR to the appropriate issue instead.

@KolaSailaja

Copy link
Copy Markdown
Author

@imDarshanGK I will do that

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.

Add source ranking to build and deploy docs

2 participants