Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve reference docs for Server APIs #306

Merged
merged 11 commits into from
Nov 14, 2024
Merged

Conversation

bcherry
Copy link
Contributor

@bcherry bcherry commented Nov 13, 2024

I found this module to be quite difficult to use within Agents due to limited documentation.

This PR:

  • Adds a clearer top-level explanation
  • Hides some red-herring modules
  • Explicitly points towards using LiveKitAPI
  • Adds return types and cross links LiveKitAPI.room, egress, etc to their documentation
  • Adds full docs for the RoomService client requests (I left others alone for now)
  • Removes the proto imports that were misleading in the docs/source as the right way to import the proto classes is via api.* (they are re-exported in __init__.py)
  • Add __aenter__ and __aexit__ to LiveKitAPI so it can be used with async with which allows cleaner example code (lmk @theomonnom if I did this wrong, I'm not super familiar)

Copy link
Member

@theomonnom theomonnom left a comment

Choose a reason for hiding this comment

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

fix CI otherwise lgtm

Copy link
Member

@davidzhao davidzhao left a comment

Choose a reason for hiding this comment

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

nice!

@bcherry bcherry merged commit bc48e91 into main Nov 14, 2024
7 checks passed
@bcherry bcherry deleted the bcherry/server-api-docs branch November 14, 2024 17:20
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.

3 participants