docs: Server Commands section lists chat commands that do not exist in the SDK

Abierto Apto para principiantes
  • ¿Algo no está bien?
#283 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Abre la sección Server Commands de README.md alrededor de las líneas 854-865 y compara sus nombres de métodos de chat con src/server-commands/chat/commands.ts. Elimina la introducción duplicada, conserva un único bloque de chat y documenta sendPublicChatMessage y sendCustomPublicChatMessage, manteniendo las notas existentes. Verifica que README ya no enumere nombres de comandos inexistentes.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

The ### Server Commands section of README.md has a duplicated structure that documents chat server commands under names that do not exist in the SDK, which leads plugin authors to call non-existent functions.

What's wrong

Two issues, both pre-existing (introduced by the v0.0.x → v0.1.x merges, confirmed via git log -S):

  1. Duplicated serverCommands intro paragraph. The line below appears twice (currently README.md:854 and README.md:859), with a partial namespace list under each:

    serverCommands object: It contains all the possible commands available to the developer to interact with the BBB core server, see the ones implemented down below:

  2. The second copy documents chat commands under non-existent names. The second chat: block lists:

    • sendPublicMessage
    • sendCustomPublicMessage

    Neither name exists in the SDK. The actual exported names (in src/server-commands/chat/commands.ts) are:

    • sendPublicChatMessage (line 43)
    • sendCustomPublicChatMessage (line 69)

    A plugin author copying from the second copy will call pluginApi.serverCommands.chat.sendPublicMessage(...), which resolves to undefined and throws at runtime.

Expected

A single serverCommands intro paragraph and a single chat: block documenting the two real methods (sendPublicChatMessage, sendCustomPublicChatMessage). The first copy already has sendPublicChatMessage correct; the second copy's sendCustomPublicMessage should become sendCustomPublicChatMessage and its accompanying note about useLoadedChatMessages / useChatMessageDomElements should be preserved.

Reproduction

# Real exports
$ git grep -nE 'send(Public|Custom)' src/server-commands/chat/commands.ts
src/server-commands/chat/commands.ts:43:  sendPublicChatMessage: (
src/server-commands/chat/commands.ts:69:  sendCustomPublicChatMessage: (

# README documents names that don't exist
$ grep -nE 'send(Public|Custom)' README.md
README.md:857:    - sendPublicChatMessage: ...
README.md:863:  - sendPublicMessage: ...
README.md:865:  - sendCustomPublicMessage: ...

Context

Surfaced while documenting presentation.insertPages in https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk/pull/277 (which intentionally scoped only the presentation: block deduplication and left this adjacent chat-block inconsistency for a separate issue, per the maintainer's request).

Lenguaje dominante
Sin datos de lenguaje
Estrellas
17
Forks
18
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de bigbluebutton/bigbluebutton-html-plugin-sdk

Todos los issues de bigbluebutton/bigbluebutton-html-plugin-sdk

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.