docs: sync README from api-spec - #158
Merged
Merged
Conversation
Closed
Closed
Closed
Closed
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Takes ownership of this README in the SDK repo.
trycourier/api-specused to overwrite it on every spec merge, from its ownREADMEs/<target>.mdoverlay. That overlay is being removed (trycourier/api-spec#200) — kits are now generated SDK source only, andREADME.mdis pruned from them. This lands the api-spec copy here once so nothing is lost, and from now on this repo owns its README.Two notes:
AUTO-GENERATED-OVERVIEWmarkers are dropped. They claimed the file was synced from mintlify-docs, butmintlify-docs/sdk-libraries/readme-exports/readme-sync-map.jsontargets only the web and mobile SDKs — never this repo. Nothing has been rewriting them, and the banner told maintainers not to edit a file they in fact own.x-release-please-start-versionmarkers so release-please keeps it current on each release (this repo already listsREADME.mdin itsextra-files).Review the content as a normal docs change — if the previous version read better in places, keep those parts.