docs: Add FAQ section#303
Open
meichuanyi wants to merge 1 commit into
Open
Conversation
JoshuaC215
pushed a commit
that referenced
this pull request
Jun 30, 2026
- #261: the contributor's real question in #259 (how to supply IndexConfig at the initialize_store() call site when it needs an embedding function, not an .env string) was never answered. Rewrote the draft to answer it: put model name + dims in settings, build IndexConfig inside initialize_store() (config-driven, off by default), with a snippet. - SKILL.md: add "answer the contributor's actual question first" pattern — check linked issues for an unanswered ask before jumping to test/lint. - #298, #303 marked Approved per Joshua. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01ALYJSRixXCfLsmb2Koc1Hi
Owner
|
Hey @meichuanyi — thanks for putting this together! An FAQ could be useful, but 147 lines is a lot to add to the README, and some of it (the framework comparisons especially) I'd need to go through carefully for accuracy and overlap with what's already documented. Could you trim it to the few questions that genuinely come up a lot, and double-check the claims against the current code/docs? If it grows beyond that, a dedicated page under |
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
2 participants
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.
This PR adds a comprehensive FAQ section to the README, covering:
The FAQ helps users quickly understand the project and find answers to common questions.