Fix up docs

This commit is contained in:
Dragory 2020-07-30 13:08:06 +03:00
parent 743a5e9ce4
commit 7909c99a7f
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
35 changed files with 371 additions and 64 deletions

View file

@ -3,6 +3,7 @@ import { CompanionChannelsPluginType, ConfigSchema, TCompanionChannelOpts } from
import { VoiceChannelJoinEvt } from "./events/VoiceChannelJoinEvt";
import { VoiceChannelSwitchEvt } from "./events/VoiceChannelSwitchEvt";
import { VoiceChannelLeaveEvt } from "./events/VoiceChannelLeaveEvt";
import { trimPluginDescription } from "../../utils";
const defaultOptions = {
config: {
@ -11,6 +12,16 @@ const defaultOptions = {
};
export const CompanionChannelsPlugin = zeppelinPlugin<CompanionChannelsPluginType>()("companion_channels", {
showInDocs: true,
info: {
prettyName: "Companion channels",
description: trimPluginDescription(`
Set up 'companion channels' between text and voice channels.
Once set up, any time a user joins one of the specified voice channels,
they'll get channel permissions applied to them for the text channels.
`),
},
configSchema: ConfigSchema,
defaultOptions,