Skip to content

Enhance public API docs#1

Merged
chasehuh merged 1 commit into
mainfrom
codex/api-docs-richness
Jun 25, 2026
Merged

Enhance public API docs#1
chasehuh merged 1 commit into
mainfrom
codex/api-docs-richness

Conversation

@chasehuh

Copy link
Copy Markdown
Member

Summary

  • expand the English and Korean Public API overview pages with base URL, auth, quickstart, async job lifecycle, upload workflow, pagination, errors, and schema links
  • replace the lightweight API reference with a route-by-route reference grounded in the current OpenAPI snapshot
  • add English and Korean API cookbook pages with copy-paste workflows for auth, generation, uploads, Asset Library, Face Swap, Reference Analysis, and error handling
  • add the cookbook pages to both sidebars

Railway docs reference

Inspected railwayapp/docs for API docs structure, especially its Public API overview, API cookbook, sidebar grouping, endpoint examples, request/response examples, code blocks, and tables. This PR borrows structure only; it does not copy Railway content.

Validation

  • pnpm install --frozen-lockfile
  • pnpm exec prettier --check content/docs/public-api.md content/docs/api/reference.md content/docs/api/cookbook.md content/docs-ko/public-api.md content/docs-ko/api/reference.md content/docs-ko/api/cookbook.md src/data/sidebar.ts src/data/sidebar-ko.ts
  • pnpm tsc
  • pnpm build
  • git diff --check
  • local smoke: /public-api, /api/reference, /api/cookbook, /ko/public-api, /ko/api/reference, /ko/api/cookbook, /api/openapi.json all returned 200 on http://localhost:3001

Notes

  • OpenAPI remains the source of truth for exact schemas.
  • The local environment still warns that package.json wants Node 20 while this machine is on Node 25.2.1; build passes with the existing warning.
  • Existing CSS optimizer warnings for generated Tailwind @property rules remain non-fatal.

@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 25, 2026 1:12am

Request Review

@chasehuh chasehuh merged commit 2b13ad8 into main Jun 25, 2026
3 checks passed
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.

1 participant