docs(readme): lead the smart graph with grouping, not linking - #477
Merged
Conversation
The intro said the graph "reveals how your notes connect" and the install note called it "graph clustering", which framed the view as an auto-linker. Grouping the vault into topics is the point, as the site lays it out; the linking is one input. Reworded the intro, hero alt, feature bullet (now names links, tags, and content as the inputs) and the embedding-model note (topics that read what notes say, not just how they link).
Contributor
Greptile SummaryThe README now presents the Smart Graph as grouping notes into topics based on links, tags, and content. The follow-up revision also clarifies that users must select an embedding model separately for search and the graph.
Confidence Score: 5/5The documentation-only PR appears safe to merge. No new actionable issues were found, and the current wording fully addresses the previously reported ambiguity about configuring embeddings separately for search and the graph. Important Files Changed
Reviews (2): Last reviewed commit: "docs(readme): say the embedding model is..." | Re-trigger Greptile |
Search and the graph select their index separately, so "add an embedding model" alone read as if one step covered both.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README-only. The intro sentence ("the graph reveals how they connect") and the install note ("graph clustering") framed the smart graph as an auto-linker, while the site leads with grouping the vault into topics. Reworded four spots to match:
No feature detail added; the README stays a pitch with links to the site.
AI assistance: written with AI coding agents from the maintainer's brief; reviewed and tested by the maintainer.