Custom Command

Hello! Welcome to our official documentation repository.

If you'd like to read our documentation, please head to doc.ccommandbot.com.
If you'd like to contribute, here's how:

Single Files

For small edits to a few files, you can navigate to the page you want to edit, scroll down and click the Improve This Page! button.
After making your changes, click the Commit changes button.
This will automatically fork the repository and create a new branch for your edit.
Finally, click the Open Pull Request button to submit your changes for review.

Multiple Files

For larger changes involving many files, we recommend using your IDE and the dev server so you can preview how everything will look.

Running the Dev Server

Requirements

Git,
Node.js >=22.18.0 or Docker Desktop

Steps

1. Fork this repository
2. Clone your forked repository to your device:

git clone https://github.com/YOUR_USERNAME/ccdoc

Or using SSH:

git clone git@github.com:YOUR_USERNAME/ccdoc.git

Node.js

3. Install dependencies:

npm i

4. Start the dev server and go to localhost:8080:

npm run dev

Docker Compose

3. Start the Docker server and go to localhost:8080:

docker compose up

Saving Changes

After your changes are done, you need to update your fork.

1. Add all files for commit:

git add .

2. Commit with your message:

git commit -m "Updated category Member"

3. Push changes to your fork:

git push

To send these changes for review, open your cloned fork on GitHub and click the Open Pull Request button.