Update documentation structure and content (#302)
## Summary - Restructure main README to focus on registry purpose and quick start guide - Streamline docs/README.md with better organization and linking - Update FAQ with current publishing methods, security approach, and community practices - Simplify roadmap to focus on go-live blockers rather than exhaustive backlog - Add ecosystem diagram to visualize registry architecture
This commit is contained in:
parent
60c75b6591
commit
d663406280
1 changed files with 177 additions and 292 deletions
|
|
@ -1,23 +1,18 @@
|
|||
# Official Registry Documentation
|
||||
|
||||
This extends [the main README](../README.md).
|
||||
|
||||
## Project Documentation
|
||||
|
||||
[`design_principles.md`](./design_principles.md) - Core constraints and principles guiding the registry design
|
||||
|
||||
[`faq.md`](./faq.md) - Frequently asked questions about the MCP Registry
|
||||
|
||||
[`roadmap.md`](./roadmap.md) - High-level roadmap for the MCP Registry development
|
||||
|
||||
[`MCP Developers Summit 2025 - Registry Talk Slides.pdf`](./MCP%20Developers%20Summit%202025%20-%20Registry%20Talk%20Slides.pdf) - Slides from a talk given at the MCP Developers Summit on May 23, 2025, with an up-to-date vision of how we are thinking about the official registry.
|
||||
- [`faq.md`](./faq.md) - Frequently asked questions about the MCP Registry
|
||||
- [`design_principles.md`](./design_principles.md) - Core constraints and principles guiding the registry design
|
||||
- [`roadmap.md`](./roadmap.md) - High-level roadmap for the MCP Registry development
|
||||
- [`MCP Developers Summit 2025 - Registry Talk Slides.pdf`](./MCP%20Developers%20Summit%202025%20-%20Registry%20Talk%20Slides.pdf) - Slides from a talk given at the MCP Developers Summit on May 23, 2025, with an up-to-date vision of how we are thinking about the official registry.
|
||||
|
||||
## API & Technical Specifications
|
||||
|
||||
[`openapi.yaml`](./openapi.yaml) - OpenAPI specification for the official registry API
|
||||
|
||||
[`api_examples.md`](./api_examples.md) - Examples of what data will actually look like coming from the official registry API
|
||||
|
||||
[`architecture.md`](./architecture.md) - Technical architecture, deployment strategies, and data flows
|
||||
|
||||
[`server.json` README](./server-json/README.md) - description of the `server.json` purpose and schema
|
||||
|
||||
[`new_package_registry.md`](./new_package_registry.md) - steps to add a new package registry for local server packages
|
||||
- [`openapi.yaml`](./openapi.yaml) - OpenAPI specification for the official registry API
|
||||
- [`api_examples.md`](./api_examples.md) - Examples of what data will actually look like coming from the official registry API
|
||||
- [`architecture.md`](./architecture.md) - Technical architecture, deployment strategies, and data flows
|
||||
- [`server.json` README](./server-json/README.md) - description of the `server.json` purpose and schema
|
||||
- [`new_package_registry.md`](./new_package_registry.md) - steps to add a new package registry for local server packages
|
||||
|
|
|
|||
Loading…
Reference in a new issue