Skip to content

Plugin Docs mismatch #528

@93arnaldo

Description

@93arnaldo

Hi folks,

Been deep-diving into plugins for python and found that several Python plugin docs are published twice under different paths:

  • https://docs.livekit.io/reference/python/livekit/plugins/... -
  • https://docs.livekit.io/reference/python/v1/livekit/plugins/... -

A concrete example is the ElevenLabs plugin:

The two pages don’t match exactly (constructor signatures / types / deprecation notes), and it’s not clear which one is canonical. The v1 docs seem to match the current Agents integration docs and package on PyPI. They typically are much more complete

I see the same “double-doc” situation for at least (manually checked each):

  • livekit.plugins.elevenlabs
  • livekit.plugins.deepgram
  • livekit.plugins.azure
  • livekit.plugins.cartesia
  • livekit.plugins.openai
  • livekit.plugins.google
  • livekit.plugins.rime
  • livekit.plugins.silero
  • livekit.plugins.speechmatics

It would be super helpful if the non-versioned /reference/python/livekit/... tree could either be removed, or redirect to /v1/..., or be clearly marked as legacy/ for older releases.

This is mainly a docs / navigation issue, but it’s confusing when signatures differ between the two pages for the same module.

Also I haven't tested this, but it seems that the non-versioned docs rank higher in search engines. For instance if I search for livekit plugin elevenlabs, the https://docs.livekit.io/reference/python/livekit/plugins/elevenlabs/index.html result is the 3rd one, right after PyPI and the main /agents docs

Thanks a lot!!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions