Skip to content

docs(readme): lead the smart graph with grouping, not linking - #477

Merged
Leo310 merged 2 commits into
mainfrom
docs/readme-graph-grouping
Sep 11, 2026
Merged

docs(readme): lead the smart graph with grouping, not linking#477
Leo310 merged 2 commits into
mainfrom
docs/readme-graph-grouping

Conversation

@Leo310

@Leo310 Leo310 commented Sep 11, 2026

Copy link
Copy Markdown
Member

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:

  • Intro: the graph groups notes into the topics the vault is actually about.
  • Hero alt text: names the grouped topics.
  • Feature bullet: works out what the vault is about from links, tags, and content, nothing to maintain (tags are new in 2.1.0).
  • Install: an embedding model gives topics that read what notes say, not just how they link. Topics from links alone already work without one, so "unlock graph clustering" was inaccurate.

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.

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).
@greptile-apps

greptile-apps Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The 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.

  • Aligns the introduction, hero alt text, feature description, and installation guidance with topic grouping.
  • Clarifies the configuration needed for semantic search and content-aware graph topics.

Confidence Score: 5/5

The 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

Filename Overview
README.md Reframes Smart Graph messaging around topic grouping and accurately clarifies embedding-model selection for both search and graph features.

Reviews (2): Last reviewed commit: "docs(readme): say the embedding model is..." | Re-trigger Greptile

Comment thread README.md Outdated
Search and the graph select their index separately, so "add an
embedding model" alone read as if one step covered both.
@Leo310
Leo310 merged commit 6bc0156 into main Sep 11, 2026
3 checks passed
@Leo310
Leo310 deleted the docs/readme-graph-grouping branch September 11, 2026 12:26
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