Home

👋 Welcome to Shape Docs

Self-hosted web portal that collects OpenAPI documentation and facilitates spec-driven development, built with GitHub-based authorization.

---

Shape Docs makes managing and previewing OpenAPI documentation a breeze, streamlining spec-driven development. With GitHub-based authorization, you can easily control who accesses your docs. Shape Docs comments on pull requests that tweak your OpenAPI specs, giving you preview URLs to ensure every update is well-reviewed.

🚀 Getting Started

• Adding Documentation to Shape Docs
• Browsing Documentation
• Updating Documentation
• Granting Access to Documentation

👩‍💻 Deploying & Contributing

• Creating a GitHub App
• Setting Environment Variables
• Deploying Shape Docs
• Limiting Pull Request Comments
• Contributing