Convert the Home to Content
Write the index page's generated docs home as home components — returned as a preview, committed, or opened as a pull request
Writes the generated docs home of the
index page as home components (<Hero>, <SectionCards> and the rest), so the
page gets back the look the generated home gave it — since 16 November 2026, a
doc engine v2 index page shows only its own content. It's what the dashboard's
Convert home to content button (on the deprecation banner) and
stx migrate use.
Needs a session token. Any member of the project's organization can ask for a
preview; commit and pr need the project admin role, and commit
also needs deploy rights.
Request Body
targetpreview returns the new page without writing anything. commit commits it
to the project's branch and starts a build. pr opens a
syntext/home-content-… branch and a pull request against the project's
branch."preview"messagedocs: write the docs home as components in <file>.Where the page is read from
The index page is read from the project's repository. A preview for a
project without a repository — or one whose repository can't be read — falls
back to the last production build's source bundle, then to the components
alone from the last build. Writing (commit or pr) always needs the
repository.
Response
modepreview, commit or pr.fromrepository, source-bundle or last-build.mdxsourcehome dropped from its frontmatter.
Absent when from is last-build.pathfrom is last-build.warningssiteurlcommit and pr only.commitShacommit and pr only.buildIdcommit. Left out if the build couldn't be started —
the commit is already saved.Error Responses
| Status | Code | When |
|---|---|---|
| 400 | validation_error | target isn't preview, commit or pr, or message is over 500 characters |
| 400 | no_repository | commit or pr on a project without a repository. Ask for the preview and paste the components into the index page |
| 403 | admin_required | commit or pr as a member, not an admin |
| 403 | deploy_rights_required | commit without deploy rights. Use pr instead |
| 404 | not_found | The project doesn't exist, or you're not in its organization |
| 404 | no_index | The last build, or the repository's branch, has no index page |
| 409 | already_content | The index page already shows its own content — it uses the home components or sets home: false |
| 409 | save_conflict | The index page changed while converting. Try again |
| 502 | github_error | GitHub refused the request. Try again |