Skip to content

docs: add examples/README.md, broaden the root README's examples intro#157

Merged
zc277584121 merged 1 commit into
zilliztech:mainfrom
zc277584121:docs/examples-readme-and-macro-intro
Jul 2, 2026
Merged

docs: add examples/README.md, broaden the root README's examples intro#157
zc277584121 merged 1 commit into
zilliztech:mainfrom
zc277584121:docs/examples-readme-and-macro-intro

Conversation

@zc277584121

Copy link
Copy Markdown
Collaborator

Summary

  • examples/README.md didn't exist. Added it as an index page stating the shared theme across all three examples: each replicates a well-known project on top of MFS, in a fraction of the code, because MFS already owns ingestion/chunking/embedding/vector-store/hybrid-search.
  • The root README's examples section pre-dated deep-research-skill and claude-context and only talked about Open Tag. Reworded the intro to state the shared theme up front, and list all three examples evenly (a table in examples/README.md, a bullet list in the root README) instead of spotlighting one.

Test plan

  • Confirmed all three example directories referenced (claude-context, deep-research-skill, open-tag-skill) exist on disk.
  • Read through both files for consistency of framing.

examples/README.md was missing entirely. Add it as an index explaining
the shared theme across the three examples: each replicates a
well-known project on top of MFS, in a fraction of the code, because
MFS already owns ingestion/embedding/vector-store/search.

The root README's examples section only talked about Open Tag (a
leftover from before deep-research-skill and claude-context existed).
Reworded it to state that shared theme up front and list all three
examples evenly instead of spotlighting one.

Signed-off-by: Cheney Zhang <chen.zhang@zilliz.com>
@zc277584121 zc277584121 merged commit 12bf508 into zilliztech:main Jul 2, 2026
8 checks passed
@zc277584121 zc277584121 deleted the docs/examples-readme-and-macro-intro branch July 2, 2026 08:42
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