diff --git a/docs/guide/getting-started/preparing.md b/docs/guide/getting-started/preparing.md index 6a6d3fa20..3b4b89790 100644 --- a/docs/guide/getting-started/preparing.md +++ b/docs/guide/getting-started/preparing.md @@ -1,10 +1,6 @@ -Tell the users how to prepare to code. -like installing node & npm & etc. - -(this is for the user who never coded before) # Preparing to Code -After installing and IDE you need to insall node. +After installing and IDE you need to install node. You can download the LTS version of node right [here](https://nodejs.org/en/download/release/latest/) \ No newline at end of file diff --git a/docs/guide/up-n-running-bot/first-steps.md b/docs/guide/up-n-running-bot/first-steps.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/guide/walkthrough/first-command.md b/docs/guide/walkthrough/first-command.md index 15522a86e..dcbda649e 100644 --- a/docs/guide/walkthrough/first-command.md +++ b/docs/guide/walkthrough/first-command.md @@ -30,10 +30,10 @@ exports.default = commandModule({ }, }) ``` -To view what each of these properties mean in depth, visit the [official documentation](https://sern-handler.js.org/docs). +To view what each of these properties mean in depth, visit the [official documentation](https://sern-handler.js.org/docs/api/enums/CommandType). ### Types of command modules Every command module `type` is part of an enum. This field allows type inference for the rest of a module's fields.
-All the command types can be found in the [official documentation](https://sern-handler.js.org/docs)! +All the command types can be found in the [official documentation](https://sern-handler.js.org/docs/api/enums/CommandType)!

So, lets say you want to make a command module that listens to modals.

**Note**: Keep in mind you'll need to send a modal with a custom id `dm-me`. This example below is the response to a modal being sent. @@ -73,7 +73,7 @@ Commands are straight forward. Keep in mind, every other property on the command optional **except** the type and execute function. # Context class -The provided Context class helps with modules of `CommandType.Both` ( A mixture of slash / legacy commands ) +The provided Context class helps with modules of `CommandType.Both` (A mixture of slash / legacy commands) In short, Slash Commands, Both Commands, Text Commands carry a Context data structure The Context class is passed into modules with type : diff --git a/docs/guide/walkthrough/first-event.md b/docs/guide/walkthrough/first-event.md index 9361dd869..8746b7781 100644 --- a/docs/guide/walkthrough/first-event.md +++ b/docs/guide/walkthrough/first-event.md @@ -23,9 +23,9 @@ exports.default = eventModule({ }) ``` Like command modules, the `type` property denotes what kind of event it is, which -can be found [here](https://sern-handler.js.org/docs). +can be found [here](https://sern-handler.js.org/docs/api/enums/EventType). -To view what each of these properties mean in depth, visit the [official documentation](https://sern-handler.js.org/docs). +To view what each of these properties mean in depth, visit the [official documentation](https://sern-handler.js.org/docs/api/enums/EventType).
Event modules are laid out similarly to command modules. These listen to any and all event you provide. diff --git a/docs/guide/walkthrough/good-to-know.md b/docs/guide/walkthrough/good-to-know.md index 3d04e5492..845e50119 100644 --- a/docs/guide/walkthrough/good-to-know.md +++ b/docs/guide/walkthrough/good-to-know.md @@ -1,9 +1,11 @@ # Good to know ## sern.config.json -A sern.config.json, although not necessary, allows your project to communicate with our cli. +

A sern.config.json, although not necessary, allows your project to communicate with our cli.

+ For example, when installing typescript plugins, the language property is necessary to install from our -[open source repository](https://github.com/sern-handler/awesome-plugins). +[open source repository](https://github.com/sern-handler/awesome-plugins).
+ Using the cli and running `sern init --sync` on pre-existing projects should install this json file in the root directory given. Or, if this is a brand-new project, `sern init` automatically installs it. diff --git a/docs/guide/walkthrough/plugins.md b/docs/guide/walkthrough/plugins.md index 7e253d0ec..428a0ef7f 100644 --- a/docs/guide/walkthrough/plugins.md +++ b/docs/guide/walkthrough/plugins.md @@ -1,9 +1,11 @@ # Plugins -As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler, -which manages permissions, categorizes, cool-downs, publishes application commands, role permissions, etc. Many important -parts that manage access and help streamline command creation to make are apparently absent. -Below is an example of an event plugin, one of the types of plugins. +

As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler, +which manages permissions, categorizes, cool-downs, publishes application commands, role permissions, etc.

+ + +

Many important parts that manage access and help streamline command creation to make are apparently absent. +Below is an example of an event plugin, one of the types of plugins.

Typescript: ```typescript diff --git a/docs/guide/walkthrough/sern-emitter.md b/docs/guide/walkthrough/sern-emitter.md index d49094559..edcaf1412 100644 --- a/docs/guide/walkthrough/sern-emitter.md +++ b/docs/guide/walkthrough/sern-emitter.md @@ -4,4 +4,5 @@ You're shipped with the SernEmitter. This EventEmitter listens to - command modules registered and its status, the `module.register` event - any errors that are recoverable, the `error` event -
You can put these and other event listeners into event modules! +
You can put these and other event listeners into event modules! +
View all events \ No newline at end of file