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

Docs Update - Livekit and Light Server #299

Merged
merged 5 commits into from
Aug 31, 2024
Merged

Conversation

MikeBirdTech
Copy link
Contributor

Update documentation to include new Livekit and Light server setup guides, remove outdated run guide, and reflect changes to 01 platform introduction and hardware documentation.

…ides, remove outdated run guide, and reflect changes to 01 platform introduction and hardware documentation.
@KillianLucas
Copy link
Collaborator

KillianLucas commented Aug 27, 2024

Nice, thanks Mike! Will make my additions to this branch and then push.

The only major thing I might play with is making a Server dropdown that opens up into Introduction, Light, and Livekit. Let me know if you have any thoughts on that (or any edits I make)

@KillianLucas
Copy link
Collaborator

KillianLucas commented Aug 29, 2024

Hey Mike! There are a few additions I'd love your help on. Was hoping in that last comment ^ that I'd have more time to do these myself but I think you'd do them better anyhow:

First it would be great to get the Light server page ~ as detailed as the Livekit page that's in this PR now. If you run it through Claude with more of the docs as context I bet it could do this.

Second I didn't get the chance to experiment with the server dropdown. I still feel like that would be a good way to do this— one server dropdown that has a Light and Livekit server. Maybe a "Choosing a server" page above them with a Card group that goes to the livekit + light server. There's a section in the livekit page I just pushed that compares them, using that or building on that could work for that page.

This I think ^ should also be fairly mirrored onto software/introduction. Essentially there are two ways of connecting to the 01 — the Livekit, and its associated clients (our official app, all the livekit SDKs) then the Light server, and its clients (the light-python client that you get with poetry run 01 and eladdekel's Native iOS app and the ESP32 client.ino file)

In an effort to make the docs more non-dev friendly: On /getting-started/getting-started I think some natural language commentary before the commands would be helpful for non devs, like on the new livekit page (mainly written by claude) that just explains why we're running the command. It would also be helpful to explain briefly what poetry is.

On the configure page, it would be great to echo the same from the new livekit page, that explains how the livekit server will ignore the .tts setting in their profile, and currently only works with deepgram and elevenlabs.

On the mobile pages, maybe let's have these pages. Would love your thoughts on this, maybe there's a much better organization:

Official App

  • Download (the main page with a card group, one for iOS install link, the other for Android. These can say "coming soon" for now)
  • Development (expo stuff about the react native Official app)
    Community Apps (With one section for now: Native iOS app by Eladdekel)

Also noticed some out of date links on /software/introduction#getting-started

On the livekit server page, it also would be fantastic to have a Card group of all the different SDK quickstarts, with links to each of them. I think an LLM could do this given the HTML on the livekit page + the Card notation.

…servers, and add information about required dependencies for MacOS and Ubuntu, including PortAudio, FFmpeg, and CMake.
@KillianLucas KillianLucas marked this pull request as ready for review August 31, 2024 07:57
@KillianLucas KillianLucas merged commit 575754e into main Aug 31, 2024
0 of 3 checks 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.

2 participants