Skip to content

add guide: How to create a LiveKit Plugin #1677

Open
jayeshp19 wants to merge 7 commits into0.xfrom
create-plugin-guide
Open

add guide: How to create a LiveKit Plugin #1677
jayeshp19 wants to merge 7 commits into0.xfrom
create-plugin-guide

Conversation

@jayeshp19
Copy link
Contributor

No description provided.

@jayeshp19 jayeshp19 requested review from a team and kath0la March 19, 2025 15:07
@changeset-bot
Copy link

changeset-bot bot commented Mar 19, 2025

⚠️ No Changeset found

Latest commit: c14ca5d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@nbsp
Copy link

nbsp commented Mar 19, 2025

would this make more sense on the Wiki tab as opposed to in the root of the repository? or at least a doc/ subdir

@bcherry
Copy link
Contributor

bcherry commented Apr 8, 2025

@jayeshp19 what's the status of this? would love to point to it from docs

@jayeshp19
Copy link
Contributor Author

@jayeshp19 what's the status of this? would love to point to it from docs

I think it's ready but not sure if we should have it in repo or docs. Wdyt?

@bcherry
Copy link
Contributor

bcherry commented Apr 8, 2025

I'd be very happy to add this to docs, we have a stub section on it already. if you're cool with that, I'll pull this in today and give you the url you can add in to the readme in its place

@jayeshp19
Copy link
Contributor Author

I'd be very happy to add this to docs, we have a stub section on it already. if you're cool with that, I'll pull this in today and give you the url you can add in to the readme in its place

That works with me

@jayeshp19
Copy link
Contributor Author

jayeshp19 commented Apr 8, 2025

I'd be very happy to add this to docs, we have a stub section on it already. if you're cool with that, I'll pull this in today and give you the url you can add in to the readme in its place

sidenote: this guide is relevant for v0,
for v1 our tests are not ready yet + we're not using pnpm changeset anymore

@bcherry
Copy link
Contributor

bcherry commented Apr 8, 2025

oh interesting in that case it is probably better in the repo since it will be version scoped more clearly?

@jayeshp19
Copy link
Contributor Author

oh interesting in that case it is probably better in the repo since it will be version scoped more clearly?

I don’t have a strong preference. I think having it in the docs is fine too, we’ll have tests in place soon anyway. We can just remove the specific steps about creating a changeset, since we still use changesets, but now they can be generated directly from the pull request.

@jayeshp19
Copy link
Contributor Author

I can update this for v1, just a few steps need to change. It's mostly a general guide.

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