feat: automatically update docs on SDK changes #767
Merged
+164
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is similar to the ones we have for the API and dashboard: it will automatically trigger docs updates when changes are merged to
mainon this repo.This helps us keep the docs up-to-date when the node SDK changes.
For now, I will not do similar PRs on other SDKs given we mostly maintain the Node.js. Once we confirm it's working well here we can bring this to the other SDKs.
Note that I also double checked the access to these env vars and possibilities of who can run the workflow etc, but I'd appreciate further checks from reviewers too.
Summary by cubic
Automatically update Resend docs when the Node.js SDK changes by adding a GitHub Actions workflow that calls the Mintlify Agent on merges to main. This keeps API reference and examples in sync without manual effort.
Written for commit 8a9332d. Summary will update automatically on new commits.