Skip to content

feat: clarify API guides and shorten the path to first usage - #499

Merged
runshouse merged 5 commits into
mainfrom
codex/docs-acquisition-audit
Sep 13, 2026
Merged

runshouse merged 5 commits into
mainfrom
codex/docs-acquisition-audit

Conversation

@runshouse

@runshouse runshouse commented Sep 7, 2026 •

Copy link
Copy Markdown
Contributor

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:

  • rebased onto current main; mergeable with no conflict markers or diff errors
  • public https://magichour.ai/docs/api/openapi.json exposes 36 Python samples; all 36 parse, including Headshot and Photo Colorizer
  • broken-link check passes; API and webhook regeneration produce no diff
  • current local preview rendered correctly at 1440px desktop and 390px mobile
  • no live generation, API-key creation, or deployment was performed

Before 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

Before After
Face Swap Video API guide before, desktop Face Swap Video API guide after, desktop

Mobile

Before After
Face Swap Video API guide before, mobile Face Swap Video API guide after, mobile

@runshouse

Copy link
Copy Markdown
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 davidhu2000 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@runshouse runshouse changed the title docs: clarify API guides and shorten the path to first usage feat: clarify API guides and shorten the path to first usage Sep 9, 2026
@runshouse
runshouse merged commit 0872383 into main Sep 13, 2026
5 checks passed
@runshouse
runshouse deleted the codex/docs-acquisition-audit branch September 13, 2026 04:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants