Repository navigation
feat: clarify API guides and shorten the path to first usage - #499
Merged
Merged
Conversation
Contributor
Author
|
Next step from PR triage: https://linear.app/magic-hour/issue/ENG-4838 contains the exact remaining evidence/release gates and acceptance checks. This is a documented handoff, not a claim that the remaining verification or publication is complete. |
davidhu2000
reviewed
Sep 9, 2026
davidhu2000
left a comment
Contributor
There was a problem hiding this comment.
Implementation review looks good. The SDK argument fixes, Python syntax corrections, navigation changes, and API-first titles are coherent, and checks pass.
I am not approving yet because this PR release sequence requires web-app #14762 to be merged and deployed first, followed by production OpenAPI sample verification. #14762 is still open. Please complete that gate and re-request review.
davidhu2000
approved these changes
Sep 13, 2026
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
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.
Developers arriving from search encounter consumer-oriented guide titles and large media examples before the API links. This gives 27 guides concise API titles, moves reference/setup links before media, and makes the guide → API reference → quickstart → pricing → API-key path explicit. It also adds the existing Postman guide to navigation and contextual links to models, account details, and starter recipes.
The related SDK/source-of-truth blockers are complete: Python SDK #167 and web-app #14762 are merged, and the released production OpenAPI now contains the corrected Headshot and Photo Colorizer samples.
Validation on
09a7b0c:main; mergeable with no conflict markers or diff errorshttps://magichour.ai/docs/api/openapi.jsonexposes 36 Python samples; all 36 parse, including Headshot and Photo ColorizerBefore and after
Live production is shown on the left; the PR result is shown on the right. These existing captures cover the changed guide surface; the rebased current head was also re-rendered at both viewports.
Desktop
Mobile