diff --git a/README.md b/README.md index 1f22ae9..fee417c 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,9 @@ The project aims to: * [x] Administrator Role Compatible * [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built in from Ollama `v0.2.1+` * [x] Automatic and Manual model pulling through the Discord client -* [ ] Allow others to create their own models personalized for their own servers! - * [ ] Documentation on creating your own LLM - * [ ] Documentation on web scrapping and cleaning ## Documentation -These are guides to the feature set included and the events triggered in this app. +These are guides to the features and capabilities of this app. * [User Slash Commands](./docs/commands-guide.md) * [Client Events](./docs/events-guide.md) diff --git a/docs/commands-guide.md b/docs/commands-guide.md index 1381ad2..5823280 100644 --- a/docs/commands-guide.md +++ b/docs/commands-guide.md @@ -78,8 +78,7 @@ This is a guide to all of the slash commands for the app. ``` /message-stream stream true ``` - > [!NOTE] - > This is a very slow progress on Discord because "spamming" changes within 5 seconds is not allowed. + **This is a very slow progress on Discord because "spamming" changes within 5 seconds is not allowed.** 3. Message Style This command allows a user to select whether to embed the app's response. diff --git a/docs/events-guide.md b/docs/events-guide.md index 2e5bc00..2e5f1f8 100644 --- a/docs/events-guide.md +++ b/docs/events-guide.md @@ -1,7 +1,9 @@ ## Events Guide This is a guide to all of the client events for the app. -> [!NOTE] Each of these is logged to the console for a developer to track. +> [!NOTE] +> * Each of these is logged to the console for a developer to track. +> * Possible interactions include commands, buttons, menus, etc. 1. ClientReady This event signifies that the Discord app is online. @@ -11,8 +13,6 @@ This is a guide to all of the client events for the app. This event signifies that a user interacted from Discord in some way. Here commands are selected from a knowledge bank and executed if found. - > [!NOTE] Possible interactions include commands, buttons, menus, etc. - 3. MessageCreate This event signifies that a message was sent. Here user questions and comments for the LLM are processed. @@ -24,4 +24,4 @@ This is a guide to all of the client events for the app. 4. ThreadDelete This event signifies that a Discord Thread was deleted. - Here any preferences set for interaction within the thread are cleared away. \ No newline at end of file + Here any preferences set for interaction within the thread are cleared away.