docs: improve structure, navigation, and coverage across documentation#97
Open
svidskiy wants to merge 5 commits intozilliztech:mainfrom
Open
docs: improve structure, navigation, and coverage across documentation#97svidskiy wants to merge 5 commits intozilliztech:mainfrom
svidskiy wants to merge 5 commits intozilliztech:mainfrom
Conversation
- index.md: remove duplicated tables (embedding providers, Milvus backends, configuration) that also live in getting-started.md; keep it as a lean landing page with brief summaries and links - getting-started.md: add zero-config quick-start section (local provider, no API key required) between Installation and the full walkthrough; add FAQ link to What's Next - faq.md: expand from 3 to 12 questions; add Troubleshooting section covering ConnectionConfigException, AuthenticationError, dimension mismatch, Windows ImportError, and macOS realpath issue; rename nav entry to 'FAQ & Troubleshooting' - claude-plugin.md: add in-page navigation TOC at the top; fix broken anchor link (milvus-backend -> milvus-backends) - python-api.md: add cross-link to architecture.md for chunk_hash - cli.md: add cross-link to getting-started.md in intro paragraph - mkdocs.yml: update FAQ nav label Closes zilliztech#91
…ucture - Split monolithic claude-plugin.md (935 lines) into 4 focused pages under docs/claude-plugin/ (overview, hooks, progressive-disclosure, troubleshooting) - Shrink ccplugin/README.md from 773 to ~130 lines with links to docs site - Add Shared Options section to CLI reference, reducing per-command duplication - Fix mermaid diagram: "Cosine similarity" → "Hybrid search (dense + BM25)" - Add missing embedding_batch_size param to Python API constructor docs - Add missing embedding.batch_size to CLI config keys table - Fix incomplete ccplugin tree in CONTRIBUTING.md and CLAUDE.md (add hooks.json, scripts/, skills/) - Move plugin-specific realpath issue from FAQ to plugin troubleshooting - Restructure mkdocs nav: group Reference (Python API + CLI), add Contributing - Remove duplicated Configuration System section from architecture.md - Add "Hybrid search" to features list in index.md - Add docs/contributing.md symlink for mkdocs nav
…add comment - Replace -- with — in all docs/ markdown files (same as README.md fix) - Remove unused MilvusStore.existing_hashes() method - Remove unused _SECTION_CLASSES import from cli.py - Remove unused Turn.line_index field from transcript.py - Add clarifying comment for setuptools dependency in pyproject.toml - Fix minor spacing in derive-collection.sh
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.
Summary
Complete documentation rewrite: eliminate duplication, fix factual errors, restructure navigation, and split oversized pages. Also remove dead code and fix typography across all files.
Problems addressed
docs/claude-plugin.mdandccplugin/README.mdembedding_batch_sizeparameter missing from Python API docs;embedding.batch_sizeconfig key missing from CLI referenceclaude-plugin.mdwas 935 lines (too long for one page);getting-started.mdconflated tutorial with reference;CONTRIBUTING.mdhad incomplete project tree; mkdocs nav was flat with no groupingccplugin/README.mdhad broken anchor links; no Contributing page in mkdocs nav--(double hyphen) used instead of—(em dash) across README.md and all docs/ filesMilvusStore.existing_hashes(), unused_SECTION_CLASSESimport in cli.py, unusedTurn.line_indexfield in transcript.pyNavigation restructure (
mkdocs.yml)Before:
After:
claude-plugin.mdinto 4 focused pagesNew files
docs/claude-plugin/index.mddocs/claude-plugin/hooks.mddocs/claude-plugin/progressive-disclosure.mddocs/claude-plugin/troubleshooting.mddocs/contributing.mdCONTRIBUTING.mdfor mkdocs navDeleted files
docs/claude-plugin.mddocs/claude-plugin/Rewritten files
docs/index.mddocs/getting-started.mdembedding.batch_sizeto TOML config example. Links to canonical tables in CLI referencedocs/python-api.mdembedding_batch_sizeparameter to constructor table. Updated search description to mention hybrid searchdocs/cli.mdembedding.batch_sizeto config keys table and config list output. Per-command option tables now reference shared optionsccplugin/README.mddocs/architecture.mddocs/faq.mdrealpath -missue to plugin troubleshooting page, replaced with cross-linkmkdocs.ymlUpdated files
CONTRIBUTING.mdhooks.json,scripts/derive-collection.sh,skills/memory-recall/SKILL.md, individual hook files. Aligned all#comments to the same columnCLAUDE.md.claude-plugin/plugin.jsonandhooks.jsonREADME.md--with—(em dash) throughoutDead code removal
MilvusStore.existing_hashes()store.py_SECTION_CLASSESimportcli.pyTurn.line_indexfieldtranscript.pyBug fixes
getting-started.mdembedding_batch_sizepython-api.mdembedding.batch_sizecli.mdindex.mdCONTRIBUTING.md,CLAUDE.mdfaq.mdclaude-plugin/troubleshooting.md--→—README.md, alldocs/*.mdCONTRIBUTING.md#in project structure tree to column 33Single source of truth
cli.md#Embedding Provider Referencegetting-started.md#Milvus Backendscli.md#Available Config Keysdocs/claude-plugin/(4 pages)Closes #91
Test plan
mkdocs build --strictcompletes with zero errorsclaude-plugin.mdlinks)embedding_batch_size/embedding.batch_sizedocumented in both Python API and CLI