Skip to content

Api getting started#1137

Open
sherry-factory wants to merge 1 commit into
mainfrom
APIGettingStarted
Open

Api getting started#1137
sherry-factory wants to merge 1 commit into
mainfrom
APIGettingStarted

Conversation

@sherry-factory
Copy link
Copy Markdown

@sherry-factory sherry-factory commented May 21, 2026

PR for creating a landing page that actually explains how to set up an API Key before being launched straight into the APIs. Details in commits as to changes, testing, etc.

docs(api-reference): add Getting Started landing page for Public API
Summary:
Adds a Getting Started landing page at /api-reference/getting-started
that introduces authentication, API key generation, permissions, and the
available endpoint groups before users land on the auto-generated OpenAPI
endpoint reference. Uses the auto-discovery openapi wrapper so new
endpoints flow into the sidebar without docs.json edits.

Changes:

  • docs/api-reference/getting-started.mdx (new)
    Frontmatter + lead paragraph, Authentication section with bearer header
    example, Generate an API key 3-step list, screenshot of the API keys
    settings page, Permissions subsection, Available Endpoints table, and a
    Next Steps CardGroup matching the format used on
    /guides/power-user/setup-checklist.
  • docs/docs.json
    Restructured the API Reference tab to mix the manual landing page with
    the auto-discovered OpenAPI endpoints under a single Endpoints wrapper
    group: { tab, pages: [getting-started, { group: Endpoints, openapi }] }.
  • docs/style.css
    Added .url-plain class override (dark + light mode) to allow inline
    prose URLs to inherit surrounding text color instead of the brand
    orange link styling.
  • docs/images/web/api-keys-page.png (new)
    Screenshot of the Factory App API Keys settings page used in the
    Generate an API key subsection.

Notes:

  • Auto-discovery wrapper preserved so the existing openapi-validate CI
    workflow in factory-mono and any downstream automation continue to work
    unchanged when new endpoints are added to the spec.
  • Tag subgroups (Computers, Sessions, Organization) collapse by default;
    this is a Mintlify limitation when using the auto-discovery openapi
    directive (expanded: true does not cascade to virtual tag subgroups).
  • The two URLs in the Generate an API key numbered list use raw
    tags with className="url-plain" so they remain clickable but render
    in the standard prose text color.
  • JP API Reference tab not mirrored in this commit; can follow up if
    needed.

Testing:

  • Verified locally with mintlify dev (CLI 4.2.573) on http://localhost:3001:
    • /api-reference/getting-started returns HTTP 200 and renders the new
      page with all sections in order: Authentication > Available
      Endpoints > Next Steps.
    • /api-reference/computers/list-computers, sessions/create-a-session,
      and organization/list-organization-users all return HTTP 200 and
      appear in the sidebar under Endpoints with the correct tag
      subgroups.
    • The api-keys-page.png screenshot serves at HTTP 200 and is visible
      inline in the Generate an API key subsection.
    • The .url-plain rule resolves to inherited text color in dark mode,
      overriding the existing .dark .prose li a:not(.card a) orange rule.
    • The Next Steps CardGroup renders as a 2-column grid with four
      cards matching the visual style of the setup-checklist page.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>

@factory-droid
Copy link
Copy Markdown
Contributor

factory-droid Bot commented May 21, 2026

Droid finished @sherry-factory's task —— View job


Adds an API Getting Started landing page and wires it into Mintlify navigation for EN/JP. Only issue spotted is a misleading duplicate link in the “All Endpoints” card; otherwise the changes look good.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 21, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
factory 🟢 Ready View Preview May 21, 2026, 5:31 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread docs/api-reference/getting-started.mdx Outdated
sherry-factory added a commit that referenced this pull request May 21, 2026
Addresses [P1] code review comment from PR #1137: the 'All Endpoints'
card was a duplicate of the 'List Computers' card (same href, different
label), which would misdirect readers.

Removed the 4th card from both EN and JP getting-started.mdx. The three
remaining cards (List Computers, Create a Session, Manage Organization
Users) cover each endpoint group, and the 'Available Endpoints' table
above already directs users to the full reference via the sidebar.

Testing:
- /api-reference/getting-started returns HTTP 200 with 3 cards in the
  Next Steps grid: List Computers, Create a Session, Manage
  Organization Users.
- /jp/api-reference/getting-started returns HTTP 200 with the
  Japanese equivalents: コンピューター一覧, セッションの作成,
  組織ユーザーの管理.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
…(EN + JP)

Summary:
Adds a Getting Started landing page at /api-reference/getting-started
(English) and /jp/api-reference/getting-started (Japanese) that
introduces authentication, API key generation, permissions, and the
available endpoint groups before users land on the auto-generated
OpenAPI endpoint reference. Uses the auto-discovery openapi wrapper so
new endpoints flow into the sidebar without docs.json edits.

Changes:
- docs/api-reference/getting-started.mdx (new)
  Frontmatter + lead paragraph, Authentication section with bearer
  header example, Generate an API key 3-step list, screenshot of the
  API keys settings page, Permissions subsection, Available Endpoints
  table, and a Next Steps CardGroup matching the format used on
  /guides/power-user/setup-checklist.
- docs/jp/api-reference/getting-started.mdx (new)
  Japanese translation: 認証 (Authentication) > 利用可能なエンドポイント
  (Available Endpoints) > 次のステップ (Next Steps). Reuses the same
  /images/web/api-keys-page.png screenshot with Japanese alt text and
  the same className="url-plain" raw <a> tags for inline URLs.
- docs/docs.json
  Restructured both the EN 'API Reference' tab and the JP 'APIリファレンス'
  tab to mix the manual landing page with the auto-discovered OpenAPI
  endpoints under a single 'Endpoints' wrapper group:
  { tab, pages: [getting-started, { group: 'Endpoints', openapi }] }.
- docs/style.css
  Added .url-plain class override (dark + light mode) so inline prose
  URLs inherit the surrounding text color instead of the brand orange
  link styling.
- docs/images/web/api-keys-page.png (new)
  Screenshot of the Factory App API Keys settings page used in the
  Generate an API key subsection of both EN and JP pages.

Notes:
- Auto-discovery wrapper preserved on both tabs so the existing
  openapi-validate CI workflow in factory-mono and any downstream
  automation continue to work unchanged when new endpoints are added
  to the spec.
- Tag subgroups (Computers, Sessions, Organization) collapse by
  default; this is a Mintlify limitation when using the auto-discovery
  openapi directive (expanded: true does not cascade to virtual tag
  subgroups).
- The two URLs in the Generate an API key numbered list use raw <a>
  tags with className="url-plain" so they remain clickable but
  render in the standard prose text color.
- Next Steps section uses three Cards (List Computers, Create a
  Session, Manage Organization Users) covering each endpoint group;
  the 'Available Endpoints' table above directs users to the full
  reference via the sidebar.
- JP code blocks, HTTP headers, and enum values left in English to
  match the existing JP reference pages (analytics-api,
  readiness-reports-api).

Testing:
- Verified locally with mintlify dev (CLI 4.2.573) on
  http://localhost:3001:
  - /api-reference/getting-started returns HTTP 200 and renders all
    sections in order: Authentication > Available Endpoints >
    Next Steps.
  - /jp/api-reference/getting-started returns HTTP 200 with H1
    はじめに and the equivalent Japanese sections.
  - /api-reference/computers/list-computers,
    sessions/create-a-session, and
    organization/list-organization-users all return HTTP 200 and
    appear in the sidebar under Endpoints with the correct tag
    subgroups (mirrored on the JP tab under /jp/api-reference/...).
  - The api-keys-page.png screenshot serves at HTTP 200 and is
    visible inline in the Generate an API key subsection of both
    EN and JP pages.
  - The .url-plain rule resolves to inherited text color in dark
    mode, overriding the existing .dark .prose li a:not(.card a)
    orange rule.
  - The Next Steps CardGroup renders three cards in a 2-column grid
    matching the visual style of the setup-checklist page.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
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