Skip to content

docs: move API versioning to getting started page#125

Merged
anttiviljami merged 1 commit intomainfrom
docs/move-versioning-to-api-page
Apr 30, 2026
Merged

docs: move API versioning to getting started page#125
anttiviljami merged 1 commit intomainfrom
docs/move-versioning-to-api-page

Conversation

@anttiviljami
Copy link
Copy Markdown
Member

Summary

  • Move API versioning and compatibility documentation from docs/architecture/api-first.md to the API landing page (/api)
  • Add "Versioning" section to the API getting started page with:
    • Compatibility guarantees (no breaking changes, additive only, 2-year minimum support)
    • Deprecation policy (12-month notice, OpenAPI marking, changelog)
    • Exceptions for security/regulatory requirements
    • Definition of breaking changes
  • Replace detailed content in api-first.md with a link to /api#versioning
  • Update page TOC to include new section

Slack thread: https://epilot.slack.com/archives/C0ADDKKTLVD/p1777544140031679

Test plan

  • Verify docs build successfully
  • Check /api page renders versioning section correctly
  • Verify TOC navigation works
  • Confirm link from api-first.md works

🤖 Generated with Claude Opus 4.5

https://claude.ai/code/session_01HVZbXfysvdk6kjDbJvU7zj

Move the API versioning and compatibility documentation from
docs/architecture/api-first.md to the API landing page at /api.

- Add Versioning section with compatibility guarantees, deprecation
  policy, and breaking change definitions to src/pages/api.tsx
- Replace detailed content in api-first.md with a link to /api#versioning
- Update TOC to include the new Versioning section

https://claude.ai/code/session_01HVZbXfysvdk6kjDbJvU7zj

Co-authored-by: Claude <noreply@anthropic.com>
@anttiviljami anttiviljami merged commit fe16143 into main Apr 30, 2026
1 check 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