docs(api-reference): rewrite overview page per style guide#2235
Merged
Conversation
added 2 commits
June 25, 2026 16:09
Fix style guide violations: remove forbidden headings (Why build, Next steps), remove bold on non-UI elements, remove 'you/your', remove 'such as', add intro sentences before lists and tables. Also add organic inline link to reseller API endpoints in Authentication section, and apply editorial improvements: intro paragraph, use cases phrasing, split auth sentence, replace 'always contain' with 'include', rename SDKs section.
…form Remove outdated Warning about dollar sign in API keys — current token format uses underscore separator (7711_eyJ...) not dollar sign. Rename 'SDKs and IaC' back to 'SDKs and Terraform'.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Add third column 'Reseller API' to the product base URLs table with direct links to IAM, CDN, Cloud, FastEdge, and Billing reseller API references. Fix link text 'permanent API token' -> 'API token' (style guide: max 2 words).
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.
Fix style guide violations: remove forbidden headings (Why build, Next steps), remove bold on non-UI elements, remove 'you/your', remove 'such as', add intro sentences before lists and tables.
Also add organic inline link to reseller API endpoints in Authentication section, and apply editorial improvements: intro paragraph, use cases phrasing, split auth sentence, replace 'always contain' with 'include', rename SDKs section.