Skip to content

docs(docs): merge API reference into one page#60

Open
Octane0411 wants to merge 5 commits intofeat/home-docs-copywriting-crofrom
feat/docs-api-reference-single-page
Open

docs(docs): merge API reference into one page#60
Octane0411 wants to merge 5 commits intofeat/home-docs-copywriting-crofrom
feat/docs-api-reference-single-page

Conversation

@Octane0411
Copy link
Collaborator

@Octane0411 Octane0411 commented Mar 5, 2026

Why

The API Reference was split across multiple pages, but we want a Claude-style single-page reference flow for faster scanning and easier onboarding.

Also, the docs site lacked a clear global footer with official brand links.

What Changed

1) Consolidated API docs into one page

  • Merged function, lifecycle, types, and tool I/O sections into:
    • /api-reference/overview/
  • Added in-page section anchors for quick navigation.

2) Updated docs entry links

  • Updated docs homepage API cards/links to point to the single API page anchors instead of split routes.

3) Navigation alignment

  • Sidebar keeps a single API entry under Reference:
    • API Reference -> /api-reference/overview/

4) Added a global docs footer with brand links

  • Added a custom Starlight Footer component override.
  • Footer now includes:
    • Official Website: https://oasai.studio/
    • X: https://x.com/OasAIStudio
    • GitHub: https://github.com/OasAIStudio/open-agent-sdk

Files Changed

  • packages/docs/src/content/docs/api-reference/overview.mdx
  • packages/docs/src/content/docs/index.mdx
  • packages/docs/src/components/Footer.astro
  • packages/docs/astro.config.mjs

Validation

  • bun run docs:build (pass)

Scope

  • Documentation-only change.
  • No runtime/package API behavior changed.

@vercel
Copy link

vercel bot commented Mar 5, 2026

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

Project Deployment Actions Updated (UTC)
open-agent-sdk-docs Ready Ready Preview, Comment Mar 5, 2026 1:55pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
open-agent-sdk-web Ignored Ignored Preview Mar 5, 2026 1:55pm

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