sapphiredev / website

Documentation for Sapphire Project

Sapphire Website

Source code for Sapphire Community website.

Running locally

After forking/cloning this repo to a folder locally:

1. Install dependencies with yarn.
2. Run yarn start to start the Docusaurus dev server

Special thanks

This project is made possible thanks to the amazing team at Polypane. We use their service to ensure you always get the latest and greatest version of the documentation. Thank you Polypane!

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
Open Collective	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

website's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• fix(deps): update all non-major dependencies (@docusaurus/core, @docusaurus/module-type-aliases, @docusaurus/plugin-pwa, @docusaurus/preset-classic, @docusaurus/theme-search-algolia, @docusaurus/tsconfig, lint-staged, wrangler)

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency ansi-regex to v6
• chore(deps): update dependency async to v3
• chore(deps): update dependency eslint to v9

Detected dependencies

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v4
• github/codeql-action v3
• github/codeql-action v3
• github/codeql-action v3

.github/workflows/continuous-integration.yml

• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4

.github/workflows/labelsync.yml

• actions/checkout v4
• crazy-max/ghaction-github-labeler v5

.github/workflows/update-submodules.yml

• actions/checkout v4
• actions/setup-node v4

npm

package.json

• @docusaurus/core 3.5.1
• @docusaurus/plugin-pwa 3.5.1
• @docusaurus/preset-classic 3.5.1
• @docusaurus/theme-search-algolia 3.5.1
• @heroicons/react ^2.1.5
• @mdx-js/react ^3.0.1
• @sapphire/docusaurus-plugin-npm2yarn2pnpm 2.0.2
• @sapphire/docusaurus-plugin-ts2esm2cjs 2.0.2
• @svgr/webpack ^8.1.0
• @tippyjs/react ^4.2.6
• clsx ^2.1.1
• prism-react-renderer ^2.3.1
• react ^18.3.1
• react-dom ^18.3.1
• swr ^2.2.5
• @commitlint/cli ^19.4.0
• @commitlint/config-conventional ^19.2.2
• @docusaurus/module-type-aliases 3.5.1
• @docusaurus/tsconfig ^3.5.1
• @sapphire/cron ^1.1.3
• @sapphire/decorators ^6.1.0
• @sapphire/duration ^1.1.2
• @sapphire/eslint-config ^5.0.5
• @sapphire/fetch ^3.0.2
• @sapphire/prettier-config ^2.0.0
• @sapphire/result ^2.6.6
• @sapphire/timer-manager ^1.0.2
• @sapphire/timestamp ^1.0.3
• @sapphire/ts-config ^5.0.1
• @types/node ^20.14.15
• @types/react ^18.3.3
• @types/react-dom ^18.3.0
• cz-conventional-changelog ^3.3.0
• eslint ^8.57.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-import ^2.29.1
• eslint-plugin-jsx-a11y ^6.9.0
• eslint-plugin-prettier ^5.2.1
• eslint-plugin-react ^7.35.0
• eslint-plugin-react-hooks ^4.6.2
• lint-staged ^15.2.8
• markdownlint ^0.34.0
• markdownlint-cli2 ^0.13.0
• prettier ^3.3.3
• rimraf ^6.0.1
• wrangler ^3.70.0
• node 20.16.0
• ansi-regex ^5.0.1
• minimist ^1.2.8
• async ^2.6.4
• yarn 4.4.0

---

• Check this box to trigger a request for Renovate to run again on this repository

request: mention `loadMessageCommandListeners` to the getting started page

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

Add a mention of how to load message commands, this has come to mind after I saw a message in #sapphire-support asking for help

Desired solution

add an info element containing something like:
If you want to use message commands. Set LoadMessageCommandListeners to true in your client options

Alternatives considered

N/A

Additional context

I am intending to submit a PR for this during hacktoberfest, only opening an issue for tracking purposes

request: update guides for Sapphire v4

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

After we release Sapphire v3 and we start working towards v4 we should start upgrading the guides to match

Desired solution

Update the guide to match the changes in v4

Alternatives considered

N.A.

Additional context

No response

bug: incorrect example

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

The examples for creating a PreCondition class is not valid

The Config object reference at line Config.bot.owners!.includes(userId) has not been delcared.

Steps To Reproduce

NA

Expected behavior

NA

Screenshots

No response

Additional context

No response

bug: link broken

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

Link with text the contribution guide in General/Welcome#contributing is broken.

Steps To Reproduce

Go here and click on blue text the contribution guide

Expected behavior

Link redirects me to the contribution guide

Screenshots

No response

Additional context

No response

request: Describe the usage of package.json in Getting Started

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

The getting started documentation should CLEARLY state that the projects package.json main field must be set correctly to ensure files are imported at runtime. I spent quite a bit of time searching the docs, and help request to find that on typescript I must set my main to my output directory.

Desired solution

Specify some sort of "Info" block that states the usage of this field.

Alternatives considered

I really don't think there are alternatives, documentation is quite clear cut.

Additional context

No response