docs: improve documentation structure and add AI development setup#53
docs: improve documentation structure and add AI development setup#53
Conversation
- Reorganize README to prioritize documentation link and simplify overview - Move detailed configuration and usage examples to external documentation - Add AI development environment setup instructions to CONTRIBUTING.md - Consolidate duplicate AI setup instructions across files
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the project documentation to improve structure and user experience by prominently featuring the documentation link and consolidating AI development setup instructions.
- Simplified README.md by removing detailed usage/configuration sections and adding a prominent documentation link
- Moved AI development environment setup instructions from README.md to CONTRIBUTING.md
- Enhanced the quickstart section clarity for different transport types
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Streamlined content by removing detailed usage/configuration sections and adding prominent documentation link |
| CONTRIBUTING.md | Added AI development environment setup instructions moved from README |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| (Listen on 80/443 and automatically set up certificates, but use the no-auto-tls option if not needed.) | ||
| - stdio (when a command is specified): MCP endpoint is https://{your-domain}/mcp. | ||
| - SSE/HTTP (when a URL is specified): MCP endpoint uses the backend’s original path (no conversion). |
There was a problem hiding this comment.
The explanation format is inconsistent. The stdio description specifies the exact endpoint format while the SSE/HTTP description is more general. Consider making both descriptions equally specific for clarity.
| - SSE/HTTP (when a URL is specified): MCP endpoint uses the backend’s original path (no conversion). | |
| - SSE/HTTP (when a URL is specified): MCP endpoint is https://{your-domain}/{original-path} (no conversion). |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Summary
This PR improves the project's documentation organization by:
Type of Change
Related Issues