Skip to content

poc(api): redesign the API changelog page#38028

Open
walidcavelius wants to merge 1 commit into
masterfrom
walid/versioning-poc-v2
Open

poc(api): redesign the API changelog page#38028
walidcavelius wants to merge 1 commit into
masterfrom
walid/versioning-poc-v2

Conversation

@walidcavelius

@walidcavelius walidcavelius commented Jul 8, 2026

Copy link
Copy Markdown

Summary

Draft POC for the redesigned /api/changelog page. The per-operation API versioning work was split into #38300.

  • Adds filter tabs for all changes, breaking changes, and deprecations.
  • Adds product and minimum-version filters with result counts, clear-filter actions, and an empty state.
  • Adds a version timeline with lifecycle and breaking-change badges, upgrade guidance, and method/type pills.
  • Adds an RSS representation and a Changelog entry to the API sidenav.
  • Keeps hand-authored placeholder content in data/api/changelog.yaml for the POC; a production implementation would generate it from the OpenAPI versioning extension.

This is a design POC for reviewer walkthrough, not intended to merge as-is.

Test plan

  • Visit /api/changelog/ on the preview build.
  • Toggle the change-type tabs and confirm entries, version sections, counts, and breaking-change badges update.
  • Select product and version filters and confirm Clear filters appears.
  • Filter to an empty result and confirm the empty state renders.
  • Confirm the filter bar remains below the sticky API toolbar without overlap on desktop widths.
  • Confirm the Changelog entry appears in the API sidenav and the RSS output renders newest-first.

@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

@datadog-prod-us1-5

This comment has been minimized.

@walidcavelius
walidcavelius force-pushed the walid/versioning-poc-v2 branch from 3fd69fe to bf53e87 Compare July 8, 2026 08:48
@walidcavelius walidcavelius changed the title poc(api): redesign /api/changelog page (D3 versioning design ask) poc(api): redesign doc for api versioning Jul 10, 2026
@nogates
nogates force-pushed the walid/versioning-poc-v2 branch from c1d2898 to af9e062 Compare July 20, 2026 12:25
@nogates nogates changed the title poc(api): redesign doc for api versioning poc(api): redesign the API changelog page Jul 20, 2026
@nogates
nogates force-pushed the walid/versioning-poc-v2 branch from af9e062 to 0e96864 Compare July 20, 2026 12:46
@nogates
nogates marked this pull request as ready for review July 21, 2026 11:40
@nogates
nogates requested review from a team as code owners July 21, 2026 11:40
@jeff-morgan-dd

Copy link
Copy Markdown
Contributor

Created DOCS-15156 for a closer look from the docs team - thanks!

@jeff-morgan-dd jeff-morgan-dd added the editorial review Waiting on a more in-depth review label Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants