Updating Documentation

Framna Docs fosters spec-driven development by requiring OpenAPI specifications to be placed in a Git repository hosted on GitHub. This ensures that specifications are kept under version control and peer-reviewed by team members.

We recommend making changes to the OpenAPI specification through pull requests and having those changes reviewed by another team member before they are merged into the default branch. The repository hosting the documentation should have branch protection rules configured to enforce review before changes are merged.

Changes to OpenAPI specifications that are pushed to the GitHub repository will instantly be reflected on Framna Docs. This also applies to changes on branches other than the default branch. See the Browsing Documentation article for more information on viewing documentation on branches and tags.

Once a pull request is opened in a repository containing OpenAPI specifications, Framna Docs will automatically comment on the PR with links to preview the documentation on Framna Docs, as shown below.

The comment lists all the OpenAPI specifications added, edited, and removed in the PR. When changes are made to the PR, such as editing another specification in the repository, Framna Docs will automatically update the comment to reflect these changes.