docs: restructure documentation for better user onboarding #309
Conversation
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
- Simplify README.md to be a landing page with quick links - Move detailed installation instructions to docs/setup/installation.md - Move configuration guide to docs/setup/configuration.md - Add new guides for MCP clients and basic usage in docs/guides/ - Extract development instructions to CONTRIBUTING.md
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation to improve user onboarding by separating user and developer concerns. The simplified README now acts as a landing page, with detailed guides moved to dedicated directories.
Changes:
- Simplified README to focus on quick start and navigation
- Created setup guides for installation and configuration
- Created usage guides for client connections and basic operations
- Moved development guidelines from README to CONTRIBUTING.md
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/setup/installation.md | New installation guide covering npx, Docker, embedded mode, and Docker Compose deployment options |
| docs/setup/configuration.md | New configuration reference documenting all settings, precedence rules, and environment variables |
| docs/guides/mcp-clients.md | New guide for connecting various MCP clients (Claude Desktop, VS Code extensions) |
| docs/guides/basic-usage.md | New guide covering web interface, CLI usage, local file scraping, and AI assistant integration |
| README.md | Simplified to landing page with quick start and links to detailed documentation |
| CONTRIBUTING.md | New developer guide with workflow, commit conventions, and architecture references |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Restructured the documentation to separate user and developer concerns, making it easier for new users to get started.
README.mdto act as a landing page.docs/setup/for installation and configuration guides.docs/guides/for client connection and usage instructions.CONTRIBUTING.md.This addresses user feedback about the documentation being convoluted.