{"repo":"framna-dk/framna-docs","free":true,"listed":false,"github":"https://github.com/framna-dk/framna-docs","clone":"git clone https://github.com/framna-dk/framna-docs.git","description":"📖❤️ Self-hosted web portal that centralizes OpenAPI documentation and facilitates spec-driven development, built with GitHub-based authorization.","language":"TypeScript","stars":48,"topics":["openapi","documentation","redocly","stoplight","swagger","openapi3","openapi31","oasdiff"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"👋 Welcome to Framna Docs Self-hosted web portal that centralizes OpenAPI documentation and facilitates spec-driven development, built with GitHub-based authorization. --- 🚀 Getting Started      👨‍🔧 How does it work?      👩‍💻 How can I contribute?      📖 Wiki Framna 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. Framna Docs comments on pull requests that tweak your OpenAPI specs, giving you preview URLs to ensure every update is well-reviewed. 🚀 Getting Started Please refer to the following articles in the wiki to get started with Framna Docs. - Adding Documentation to Framna Docs - Browsing Documentation - Updating Documentation - Deploying Framna Docs Install the OpenAPI diff tool locally Framna Docs relies on the oasdiff CLI when comparing specifications. On MacOS you can install with homebrew: 👨‍🔧 How does it work? Framna Docs uses OpenAPI specifications from GitHub repositories. Users log in with their GitHub account to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Framna Docs, but customization is possible with a .framna-docs.yml file. Here's an example: Framna Docs supports spec-driven development by requiring OpenAPI specs in GitHub repos, ensuring version control and peer review. When a pull requ","default_branch":null,"files":null,"tree":[],"storefront":"/r/framna-dk","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/framna-dk/framna-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}