Skip to content

API docs: Group Index and release notes + add divider#4760

Merged
arnaucasau merged 65 commits intomainfrom
AC/reorder-api-toc
Mar 9, 2026
Merged

API docs: Group Index and release notes + add divider#4760
arnaucasau merged 65 commits intomainfrom
AC/reorder-api-toc

Conversation

@arnaucasau
Copy link
Collaborator

@arnaucasau arnaucasau commented Mar 6, 2026

This PR reorders the TOC of every API to have a first section with the API index and the release notes. Moreover, it adds a divider to help differentiate between metadata about the API versus the API itself.

The only manual commit is c761bb9. The rest were generated by npm run regen-apis

@arnaucasau arnaucasau changed the title [WIP] API docs: Group Index and release notes + add divider API docs: Group Index and release notes + add divider Mar 6, 2026
@arnaucasau arnaucasau force-pushed the AC/reorder-api-toc branch from ddcede0 to faefc5a Compare March 6, 2026 13:01
@arnaucasau arnaucasau marked this pull request as ready for review March 6, 2026 13:02
Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Arnau!

Could you please revert the changes to the public folder? I think this is from how the images depend on which device we use. It'd be best to avoid the big diff

@arnaucasau
Copy link
Collaborator Author

Could you please revert the changes to the public folder? I think this is from how the images depend on which device we use. It'd be best to avoid the big diff

Restored in cea45b1 👍. Yeah, this is because the last dev docs generation was done in CI and I just used npm run regen-apis (#2517)

@arnaucasau arnaucasau requested a review from Eric-Arellano March 9, 2026 12:57
@arnaucasau arnaucasau added this pull request to the merge queue Mar 9, 2026
Merged via the queue into main with commit b933cf5 Mar 9, 2026
5 checks passed
@arnaucasau arnaucasau deleted the AC/reorder-api-toc branch March 9, 2026 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants