StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-06-08 00:05:01 +00:00
Code Releases Activity

chore: reorganize plugin docs

Browse source
This commit is contained in:
Dragory 2024-08-11 02:05:23 +03:00
parent dfdc6566cf
commit 460b65d1df
No known key found for this signature in database
53 changed files with 382 additions and 288 deletions
Download patch file Download diff file Expand all files Collapse all files

22
backend/src/types.ts
View file

@ -1,4 +1,4 @@
import { BaseConfig, Knub } from "knub";
import { BaseConfig, GlobalPluginBlueprint, GuildPluginBlueprint, Knub } from "knub";
import z, { ZodTypeAny } from "zod";
import { zSnowflake } from "./utils.js";
@ -33,12 +33,24 @@ export type TZeppelinKnub = Knub;
*/
export type TMarkdown = string;
export type ZeppelinPluginType = "stable" | "legacy" | "internal";
export interface ZeppelinGuildPluginInfo {
plugin: GuildPluginBlueprint<any, any>;
docs: ZeppelinPluginDocs;
autoload?: boolean;
}
export interface ZeppelinPluginInfo {
type: ZeppelinPluginType;
prettyName: string;
export interface ZeppelinGlobalPluginInfo {
plugin: GlobalPluginBlueprint<any, any>;
docs: ZeppelinPluginDocs;
}
export type DocsPluginType = "stable" | "legacy" | "internal";
export interface ZeppelinPluginDocs {
type: DocsPluginType;
configSchema: ZodTypeAny;
prettyName?: string;
description?: TMarkdown;
usageGuide?: TMarkdown;
configurationGuide?: TMarkdown;