You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When you push changes to the `main` branch in this repository, a GitHub Actions workflow automatically triggers an update in the [`phrase/developer-hub`](https://github.com/phrase/developer-hub) repository.
63
+
Changes pushed to the main branch automatically trigger an internal workflow that updates the API documentation based on the latest OpenAPI schema.
64
64
65
-
That workflow:
65
+
This includes:
66
66
67
-
1. Pulls the latest OpenAPI schema from this repo,
68
-
2. Regenerates the documentation,
69
-
3. Creates a pull request with the updated documentation,
70
-
4. Includes a link to a **Mintlify staging environment**, where you can preview the changes live.
67
+
1. Pulling the most recent schema from this repository,
68
+
2. Regenerating the documentation site,
69
+
3. Deploying the updated docs.
71
70
72
-
You don't need to manually sync or copy the OpenAPI file to the documentation repo. Just review and merge your changes to `main` here - the rest is handled for you.
71
+
You don't need to take any additional steps. Just make sure your changes are properly committed and merged into main – the documentation will be updated automatically.
73
72
74
-
This ensures that our API documentation stays in sync with the latest changes to the spec.
73
+
This setup ensures that the public API documentation always reflects the current OpenAPI spec.
0 commit comments