Skip to content

Commit bcd12c8

Browse files
authored
docs: Update Readme (#851)
1 parent fb5d3c8 commit bcd12c8

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ You added an endpoint in Phrase Strings. In this project you do the following:
3434
2. Add new endpoints to `/paths/` directory and reference it in `paths.yaml`
3535
3. `npm start` to re-build the clients
3636
4. Open a PR with an informative title (e.g. `feat(API): Add an API endpoint for cat pics`)
37-
5. Merge automated documentation PR created in `phrase/developer-hub` [(details)](#documentation-sync-mintlify)
37+
5. Merge automated documentation PR [(details)](#documentation-sync)
3838

3939
## Workflow
4040

@@ -58,20 +58,19 @@ https://github.com/phrase/phrase-cli
5858

5959
![Deployment diagram](docs/openapi%20workflow.svg)
6060

61-
## Documentation Sync (Mintlify)
61+
## Documentation Sync
6262

63-
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.
6464

65-
That workflow:
65+
This includes:
6666

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.
7170

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 mainthe documentation will be updated automatically.
7372

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.
7574

7675
## Specification
7776

0 commit comments

Comments
 (0)