✨ Feat: add the documentation website

CONTRIBUTING.md

@@ -1,22 +1,51 @@
-### 📦 Preparing the commit
+### 🐾 Steps to follow
 
-1. Check for lint errors and format the code:
+#### 📋 Fork the repository
+
+First, you need to fork the repository to your GitHub account. Click on the "Fork" button on the top right corner of the repository page.
+
+#### 🌿 Create a branch
+
+Create a new branch based on the `develop` branch with a objective name for your contribution:
+
+```bash title="Terminal"
+git checkout -b feature/your-feature-name develop
+```
+
+#### ⌨️ Develop your changes
+
+If you need help to quickstart the local environment, check the [Getting Started](/getting-started) guide.
+
+#### 📦 Preparing the commit
+
+After all changes done, check for lint errors and format the code:
+
+- For the chatbot:
 
 ```console
 pipenv run isort . && pipenv run black .
 ```
 
+- For the documentation:
+
+```console
+npm run lint && npm run format
+```
+
+> [!TIP]  
+> If you use `pnpm`, `yarn`, or `bun`, simply replace `npm` with the respective package manager.
+
  
 
-### ✍️ Opening a pull request
+#### ✍️ Opening a pull request
 
-All done? Now you can open a pull request and wait for the review.
+All done? Now you can push your changes to your forked repository and open a pull request to wait for a review.
 
 > [!IMPORTANT]  
-> Don't forget to correctly describe your committed activities and pull requests.
+> Don't forget to correctly describe your changes within the commits and the pull request.
 
  
 
 ### 📜 Code of Conduct
 
-See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
+Be sure to read and follow all of the rules on our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

README.md

@@ -103,7 +103,7 @@ pipenv run bot
 
 ### 🚀 Deploy
 
-Currently hosted on Heroku and running 24/7, you can check our [Heroku deployment documentation](https://sonny.juliomartins.dev/guide/heroku) for more info on how to deploy the chatbot to Heroku.
+Currently hosted on Heroku and running 24/7, you can check our [Heroku deployment documentation](https://sonny.juliomartins.dev/guides/heroku) for more info on how to deploy the chatbot to Heroku.
 
  
 

docs/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

docs/.prettierignore

@@ -0,0 +1,2 @@
+# Ignore all MDX files:
+**/*.mdx

docs/.prettierrc.mjs

@@ -0,0 +1,12 @@
+/** @type {import("prettier").Config} */
+export default {
+  plugins: ["prettier-plugin-astro"],
+  overrides: [
+    {
+      files: "*.astro",
+      options: {
+        parser: "astro",
+      },
+    },
+  ],
+};

docs/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

docs/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "name": "Development server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

docs/astro.config.mjs

@@ -0,0 +1,49 @@
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+
+export default defineConfig({
+  integrations: [
+    starlight({
+      title: "Sonny",
+      logo: {
+        light: "./src/assets/light-logo.svg",
+        dark: "./src/assets/dark-logo.svg",
+        replacesTitle: true,
+      },
+      social: {
+        twitch: "https://twitch.tv/superp0sit1on",
+        github: "https://github.com/superp0sit1on/sonny",
+      },
+      sidebar: [
+        {
+          label: "Start Here",
+          items: [
+            { label: "Getting Started", link: "/getting-started" },
+            { label: "Releases Notes", link: "/releases" },
+          ],
+        },
+        {
+          label: "Guides",
+          items: [
+            { label: "Project Structure", link: "/guides/project-structure" },
+            { label: "Writing Commands", link: "/guides/writing-commands" },
+            {
+              label: "Managing Modules",
+              link: "/guides/managing-modules",
+            },
+            { label: "Deploy to Heroku", link: "/guides/deploy-to-heroku" },
+            {
+              label: "Documenting",
+              link: "/guides/documenting",
+            },
+            { label: "Contributing", link: "/guides/contributing" },
+          ],
+        },
+        {
+          label: "Resources",
+          autogenerate: { directory: "resources" },
+        },
+      ],
+    }),
+  ],
+});

docs/eslint.config.js

@@ -0,0 +1,8 @@
+import eslintPluginAstro from "eslint-plugin-astro";
+export default [
+  ...eslintPluginAstro.configs.recommended,
+  ...eslintPluginAstro.configs["jsx-a11y-recommended"],
+  {
+    rules: {},
+  },
+];