docs: add FAQ section for common questions#3
Open
meichuanyi wants to merge 1 commit into
Open
Conversation
Reviewer's GuideAdds a new FAQ section to the README to document common questions about n8n_agent, its MCP-based integrations, workflow analysis, database backends, and troubleshooting steps, without modifying any runtime code. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider aligning terminology and capitalization throughout the FAQ (e.g.,
QDRANTvsQdrant,n8n_agentvsn8n agent, MCP tool names) with the rest of the README and actual CLI/tool identifiers to avoid confusion. - Some FAQ answers repeat content already described above (e.g., workflow analysis details, validation categories); you might instead link back to the relevant sections to keep the README shorter and avoid having to maintain the same information in two places.
- For items marked as "(Currently in development)" in the database integration section, clarify the current level of support or expected behavior so readers know whether these are safe to use or still experimental.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider aligning terminology and capitalization throughout the FAQ (e.g., `QDRANT` vs `Qdrant`, `n8n_agent` vs `n8n agent`, MCP tool names) with the rest of the README and actual CLI/tool identifiers to avoid confusion.
- Some FAQ answers repeat content already described above (e.g., workflow analysis details, validation categories); you might instead link back to the relevant sections to keep the README shorter and avoid having to maintain the same information in two places.
- For items marked as "(Currently in development)" in the database integration section, clarify the current level of support or expected behavior so readers know whether these are safe to use or still experimental.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
Adds a comprehensive FAQ section to help users understand and use the n8n workflow vectorization and knowledge graph project.
Changes
Benefits
Testing
Pure documentation improvement, no code changes.
Summary by Sourcery
Add a comprehensive FAQ section to the README to answer common questions about using and integrating the project.
Documentation: