Skip to content

feat: Generate API Documentation Pages#549

Open
zastrowm wants to merge 10 commits intostrands-agents:workstream/cms-migrationfrom
zastrowm:generate_api_docs
Open

feat: Generate API Documentation Pages#549
zastrowm wants to merge 10 commits intostrands-agents:workstream/cms-migrationfrom
zastrowm:generate_api_docs

Conversation

@zastrowm
Copy link
Member

@zastrowm zastrowm commented Feb 13, 2026

Description

Note: This is targeting the workstream/cms-migration branch.

Generate API documentation for both Python & TypeScript. The way we do this in Starlight/Astro is by:

  • Cloning the sdk repositories
  • Generating markdown files from the repositories
  • Pull those markdown files into the CMS and publish under api/{language}/thing

Additions

  • Scripts to clone SDKs and generate markdown (clone-sdks.ts, api-generation-python.py, api-generation-typescript.ts)
  • Dynamic sidebar generation from content collection (dynamic-sidebar.ts)
  • Python groups by module path, TypeScript groups by type category

Notes

  • Both use flat slugs (api/typescript/Agent) but sidebar groups by category or modules via frontmatter
  • Index pages that auto-render module/type lists via Astro components
  • There are still links from pages that should be going to api documentation, but do not (they're pointing to the right place); I have not yet addressed that as this PR focuses on the pages

Previews:

Related Issues

#441

Type of Change

  • Content update/revision

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • Links in the documentation are valid and working

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@zastrowm zastrowm changed the base branch from main to workstream/cms-migration February 13, 2026 19:43
@github-actions
Copy link
Contributor

github-actions bot commented Feb 13, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-549/user-guide/quickstart/overview/

Updated at: 2026-02-13T20:47:28.743Z

@strands-agents strands-agents deleted a comment from github-actions bot Feb 13, 2026
@strands-agents strands-agents deleted a comment from strands-agent Feb 13, 2026
@strands-agents strands-agents deleted a comment from strands-agent Feb 13, 2026
@zastrowm zastrowm marked this pull request as ready for review February 13, 2026 20:58
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