Update docs

raidensakura · Jun 6, 2023 · 20f2045 · 20f2045
1 parent 7655e86
commit 20f2045
Show file tree

Hide file tree

Showing 16 changed files with 255 additions and 155 deletions.
diff --git a/PRIVACY.md b/PRIVACY.md
@@ -116,7 +116,7 @@ If you wish to opt out of any of this data collection, please view their own pri
 
 For a maximum privacy setup, we recommend the following hosting procedure. We have included links to various help articles for each relevant step. We will not provide support for such a procedure.
 - [Creating a local mongodb instance](https://zellwk.com/blog/local-mongodb/)
-- [Hosting Modmail on your personal computer](https://taaku18.github.io/modmail/local-hosting/)
+- [Hosting Modmail on your personal computer](https://docs.modmail.dev/)
 - Ensuring `data_collection` is set to `no` in the `.env` file.
 - [Opt out of discord data collection](https://support.discord.com/hc/en-us/articles/360004109911-Data-Privacy-Controls)
 - Do not use any plugins, setting `enable_plugins` to `no`.
diff --git a/README.md b/README.md
@@ -76,11 +76,11 @@ There are a few options for hosting your very own dedicated Modmail bot.
 
 1. Patreon hosting
 2. Local hosting (VPS, Dedicated Server, RPi, your computer, etc.)
-3. PaaS (we provide a guide for Heroku)
+3. PaaS (Currently tested are Heroku, Railway, Northflank, Zeabur & Koyeb)
 
 ### Patreon Hosting
 
-If you don't want the trouble of renting and configuring your server to host Modmail, the original developers offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for more info! 
+If you don't want the trouble of renting and configuring your server to host Modmail, the original developers offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join the official [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for more info! 
 
 ### Local hosting (General Guide)
 
@@ -93,10 +93,10 @@ This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/down
     $ git clone https://github.com/modmail-dev/modmail
     $ cd modmail
     ```
-2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
-3. Create a free MongoDB database ([guide](https://github.com/modmail-dev/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
+2. Create a Discord bot account, grant the necessary intents, and invite the bot.
+3. Create a free MongoDB database.
 4. Rename the file `.env.example` to `.env` and fill it with appropriate values
-   - If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
+   - If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/raidensakura/modmail/stable/.env.example) and replace the placeholders with their values
    - If you're on Windows and cannot save the file as `.env`, save it as `.env.` instead (this only applies to Windows!)
    - If you do not have a Logviewer yet, leave the `LOG_URL` field as-is
 5. Update pip, install pipenv, and install dependencies using pipenv
@@ -109,7 +109,7 @@ This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/down
     ```console
     $ pipenv run bot
     ```
-7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/modmail-dev/logviewer)
+7. Set up the Logviewer.
 
 ### Local Hosting (Docker)
 
@@ -131,64 +131,26 @@ Docker images are hosted on [GitHub Container Registry](ghcr.io), you can build
 $ docker build --tag=modmail:stable .
 ```
 
-Then simply remove `ghcr.io/modmail-dev/` from the `docker-compose.yml` file.
+Then simply remove `ghcr.io/raidensakura/` from the `docker-compose.yml` file.
 
 ### Local Hosting (OS-Specific)
 
-Refer to our [documentation](https://modmail-docs.netlify.app) for more info.
+Refer to the [documentation](https://modmail-docs.netlify.app) for more info.
 
 ### Platform as a Service (PaaS)
 
 You can host this bot on various PaaS such as Heroku, Railway, and others.
 
-Installation via Heroku is possible with your web browser alone. 
-The [**installation guide**](https://github.com/modmail-dev/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join the [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for help and support.
-
 When using Heroku, you can configure automatic updates:
  - Login to [GitHub](https://github.com/) and verify your account.
- - [Fork the repo](https://github.com/modmail-dev/modmail/fork).
+ - [Fork the repo](https://github.com/raidensakura/modmail/fork).
  - Install the [Pull app](https://github.com/apps/pull) for your fork. 
  - Then go to the Deploy tab in your [Heroku account](https://dashboard.heroku.com/apps) of your bot app, select GitHub and connect your fork (usually by typing "Modmail"). 
  - Turn on auto-deploy for the `stable` branch.
 
 ## Sponsors
 
-Special thanks to the sponsors for supporting the project.
-
-SirReddit:
-<br>
-<a href='https://www.youtube.com/channel/UCgSmBJD9imASmJRleycTCwQ/featured'>
-  <img height=100 src='https://i.imgur.com/WyzaPKY.png' style='margin:5px'>
-</a>
-<br>
-<br>
-Prime Servers Inc:
-<br>
-<a href='https://primeserversinc.com/'>
-  <img height=100 src='https://i.imgur.com/sVcwtt8.png' style='margin:5px'>
-</a>
-<br>
-<br>
-Real Madrid:
-<br>
-<a href='https://discord.gg/realmadrid'>
-  <img height=100 src='https://i.imgur.com/9Rat2Qb.png' style='margin:5px'>
-</a>
-<br>
-<br>
-Advertise Your Server:
-<br>
-<a href='https://discord.gg/zP8KcF4VQz'>
-  <img height=100 src='https://user-images.githubusercontent.com/45324516/140673115-dd3e873c-36b6-4383-9eb4-db42e1986ab3.png' style='margin:5px'>
-</a>
-<br>
-<br>
-Discord Advice Center:
-<br>
-<a href='https://discord.gg/zmwZy5fd9v'>
-  <img height=100 src='https://i.imgur.com/1hrjcHd.png' style='margin:5px'>
-</a>
-
+For list of official sponsors, refer to the original repository [here](https://github.com/modmail-dev/modmail).
 
 Become a sponsor on [Patreon](https://patreon.com/kyber).
 
@@ -197,20 +159,23 @@ Become a sponsor on [Patreon](https://patreon.com/kyber).
 Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
 Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail. 
 
-You can find a list of third-party plugins using the `?plugins registry`  command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
+You can find a list of third-party plugins using the `?plugins registry`  command on the bot or by reading through the official [REGISTRY.json](https://github.com/modmail-dev/modmail/blob/master/plugins/registry.json).
 
 To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).
 
 Plugins requests and support are available in the [Modmail Support Server](https://discord.gg/cnUpwrnpYb).
 
-## Contributing
+## Support & Issues
 
-Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out the [contributing guidelines](https://github.com/raidensakura/modmail/blob/stable/.github/CONTRIBUTING.md) before you get started.
+Issues with the bot can be opened through [GitHub Issues](https://github.com/raidensakura/modmail/issues/new/choose).
 
-If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!
+Support for this forked version of Modmail can be requested through [Raiden's Discord server](https://dsc.gg/transience).
+As I don't have a dedicated team to answer questions and provide help, it will be be answered when I'm available.
 
-## Beta Testing
+## Contributing
+
+Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out the [contributing guidelines](https://github.com/raidensakura/modmail/blob/stable/.github/CONTRIBUTING.md) before you get started.
 
 The [develop](https://github.com/raidensakura/modmail/tree/develop) branch is where most of the features are tested before stable release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.
 
-If you wish to test the new features and play around with them, feel free to join the [Public Test Server](https://discord.gg/v5hTjKC). Bugs can be raised within that server or in our Github issues (state that you are using the development branch though).
+If you like the original project and would like to show your appreciation, support the authors on **[Patreon](https://www.patreon.com/kyber)**!
diff --git a/docs/README.md b/docs/README.md
@@ -1,23 +1,23 @@
-# Nextra Docs Template 
+# Modmail Docs
 
-This is a template for creating documentation with [Nextra](https://nextra.site).
+This is the documentation directory for Modmail bot, powered by [Nextra](https://nextra.site).
 
-[**Live Demo →**](https://nextra-docs-template.vercel.app)
+The page is live at https://modmail-docs.netlify.app.
 
-[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
+## Deploying your own site
 
-## Quick Start
-
-Click the button to clone this repository and deploy it on Vercel:
+Click the button to clone the official nextra repository and deploy it on Vercel:
 
 [![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
 
-## Local Development
+## Development & Contributing
+
+[Node.js](https://nodejs.org/en) and [pnpm](https://pnpm.io/installation) must be installed.
 
 First, run `pnpm i` to install the dependencies.
 
 Then, run `pnpm dev` to start the development server and visit localhost:3000.
 
 ## License
 
-This project is licensed under the MIT License.
+This project directory is licensed under the MIT License.
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -4,7 +4,7 @@
     "title": "About",
     "type": "page"
   },
-  "get-started": "Getting Started",
+  "getting-started": "Getting Started",
   "installation": "Installing Modmail",
   "logviewer-installation": "Installing Logviewer",
   "configuration": "Configuring Modmail",

diff --git a/docs/pages/community-guides.mdx b/docs/pages/community-guides.mdx
@@ -1,15 +1,55 @@
 import { Callout } from 'nextra-theme-docs'
+import { Card, Cards } from 'nextra-theme-docs'
 
 # Community Guides
 
 <Callout emoji="ℹ️" type="info">
 	Community guides are not verified by the Modmail team, so use them at your own risks.
 </Callout>
 
-## [Replit Guide](https://gist.github.com/anondev-sudo/24978429b85b44348bcff5c0885afe82) by AnonDev
+### Hosting on [Replit](https://replit.com/)
 
-An online code execution environment. You can host Modmail there for free using certain exploits. The legitimate method costs $7 USD per month. However, regardless if you pay or host for free, hosting on Replit are often unstable and thus not recommended. But for now, this is the only option for those without a payment method for hosting or verification.
+Replit is an online code execution playground. You can host Modmail there for free using certain exploits.
+The legitimate method costs $7 USD per month. However, regardless if you pay or host for free, 
+hosting on Replit are often unstable and thus not recommended. But for now, this is the one of the only options
+for those without a payment method for hosting or verification.
+  <br/>
+  <Card
+    icon={
+      <img src="https://replit.com/public/icons/favicon-prompt-192.png" alt="drawing" width="25"/>
+  	}
+    title="Replit Hosting Guide by AnonDev"
+    href="https://gist.github.com/anondev-sudo/24978429b85b44348bcff5c0885afe82"
+  />
 
-## [Northflank](https://blog.project-mei.xyz/2023/04/11/hosting-discord-modmail-on-northflank/) Guide by raidensakura
+### Hosting on [Northflank](https://northflank.com/)
 
-Northflank is a Platform as a Service (PaaS) like Railway that offers abilities to run micro-services like bots, schedule jobs that run periodically and databases with a powerful UI, API and CLI. Their panel is a bit more advanced as compared to Railway but comes with the perk of more customization and features. You will need a valid payment method to verify your account, but will unlock a free tier project that's separated from paid resources. They will not charge your card if you go over resource usage as you have limited allocation per service.
+Northflank is a Platform as a Service (PaaS) like Railway that offers abilities to run micro-services like bots,
+schedule jobs that run periodically and databases with a powerful UI, API and CLI.
+Their panel is a bit more advanced as compared to Railway but comes with the perk of more customization and features.
+You will need a valid payment method to verify your account, but will unlock a free tier project that's separated from paid resources.
+They will not charge your card if you go over resource usage as you have limited allocation per service.
+  <br/>
+  <Card
+  	icon={
+      <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAFSUlEQVR4Ae3VA5AcWBSF4TPm2rZt2xsvY9u
+	  2bdse21Zs27Y9uPvXVk/HSXl5qr44c8+8ftDfP//n/6RmIPNhpSc1UEZca7RyaI2S8ICcWdS+0FNojNZohdYO38MVunkSF0vxqz2UPGek0tJNGfGIu9
+	  RhfAPh0gK+CIRdw268C924RNw6KWEFBVZ9TZGjSsk5wyrEMmimw1IY4nEbpHn9pYUdpQXdimhRh+MMOIFIBCAQa2GYAe8bF4jeKUXtvlWxm+IUv9KUt
+	  CCYj8NPWeEuYhg+xD7kohqkOSMxyp8iA7Ww60EGjNaidp6FS44fcRynUQq6dsKPU2CHFHmgCkUuKG79flbjQ1ZDrIYYhlhXfu4LwzI8quwAafaE1zV3
+	  2AjN7x2uhZ1f0MIul340nhgHQybu0zUTeg4XHlH4iaWK3GeK2dZPSXNdFbtRCjaKHfJW5EEvpSc8y+A1MHRVZqSHcqZ/qNljW2rukKJaW0ya3+fKzVk
+	  S53EMX+jK+M801ehlcgsq6EwRU8TRNYra+zRFGF4Ae0GhZycqeldnVuVLZSS0ZXgeduEdZQc9oZwpX1DCH1eeDm9MhSEZd+nS3DfNdM90Ez+/SZGdrs
+	  H5+Qo7U1+BJoXki+EeGMuvcxVxJFuxG1qxOSkRlwXDZFbhDkrcqrQMsRqSCB8DewEdSjD0FE7gR+iyvDTB9NY483pisk2iiHkHWjrD7nIJ/nO48C2O4
+	  RSrU08xW15UwvK7GFwCJx2KQYIz83uh911szExKGIMnwRNy5rPRpjfGm94da0UpcuKRKXbyrulW/H5WxTH8NiTAEAgfyDHMC5NhSMOdkAgbUmxGjuiA
+	  BhTJ59c7GfwGJDjz43BTsWF25+ejLPXtcWbPTbSp904zL4oUFiiHXBzAB5CzAPAW9iLfeSyhOaOl2WOeochajqdpQY9O2v40pTrJmcoDTV+ONP06xOp
+	  QJO/j0bb7zXH2NkXkE+AsUB0F2IPXIQWBOIa9iO0w1IeUM0PKjHLVrEkDKGKcjCWa3+8Riuiy1KBYrf72ZKWBtvqnoWbfjbBuCjOXT/g/pLDAPciBYR
+	  w8UDjcHcNgmI8HIDajlBXyEUUOaNaEC1xSlflZFJEzNRkOV/ShiJUfZMtKDbVHKSJnGOTwM07jGH5QzA5/xa19VGkpvzDwEM6hLMTxFFe3LysQomz+c
+	  860WM0edysXlchVBd7HPuRWH2DV6/c1VRhkErmLTegXYLp7uvl6BdqdDJ4JQ6rCj32iuA1NlTw7jUspl8Hh8IMYLqWm/86fn1Vm+BFlB36trGApJ+Cq
+	  Ar6YCUMCboMK8xong9Ph/dRk+/De6fY4gz/EXrAh81twVX+nhGV9eS1jGPwBL6aUuAiL76PYHKWlGtf2SK5pd4roqji++4PIQ1kIEuFUiMHiZHxCiWa
+	  PTrGPfQPMm+G9YVihkNxnKXAbT/btfNcuSlwqZYWJd6MlRUwp2Vv4iF5SWpquGYY9gNkwjIIHJMLHIDbmwyWG2RROxkjuhw84mmLwk1gFQ3dOgws/O1
+	  7R7djxIu/GZq5q4xVtRUlxY163gPAbzuIovoGgJn3MhY3ZlY25j+M55v2xdtf7Y5wbsg7ysBtvQ+IVVeh5d0XuH0ERU9y6uazO/RQRuWEBX4TAsAj9H
+	  UZgf7UBdrbMYKvA5tQPw50F7kAqDNnoh/58t2MpcpQH7CyvaGlF7xZvxk0LCB9hP+waUlmJO3HlsSyC4zA5FRivpfFYhfJi+lFEjty0hBvKYBiGOgzD
+	  ALwN4cq7wQvVMBxDHYaxCn0UduolhZ6Rwo/qb53/83/+AFhNZSejAD8zAAAAAElFTkSuQmCC" alt="drawing" width="25"/>
+  	}
+    title="Northflank Guide by raidensakura"
+    href="#"
+  />
diff --git a/docs/pages/frequently-asked-questions.md b/docs/pages/frequently-asked-questions.md
diff --git a/docs/pages/frequently-asked-questions.mdx b/docs/pages/frequently-asked-questions.mdx
@@ -0,0 +1,26 @@
+import { Steps } from 'nextra-theme-docs'
+
+# Frequently Asked Questions
+
+<Steps>
+
+### Error installing from Pipfile and Pipfile.lock
+
+First, make sure you have a compatible Python version.
+
+Second, remove the broken `Pipfile` and `Pipfile.lock` with:
+```bash
+rm Pipfile && rm Pipfile.lock
+```
+
+Fetch in the changes from the remote repository:
+```bash
+git fetch origin
+```
+
+And then, fetch the original files with:
+```bash
+git checkout FETCH_HEAD -- Pipfile && git checkout FETCH_HEAD -- Pipfile.lock
+```
+
+</Steps>
diff --git a/docs/pages/getting-started.mdx b/docs/pages/getting-started.mdx
@@ -221,7 +221,7 @@ not be able to assist you much with community-made guides. Feel free to check th
 	Community guides are not verified by the Modmail team, so use them at your own risk.
 </Callout>
 
-<Cards>
+<br/>
   <Card
     icon={
       <svg
@@ -239,47 +239,6 @@ not be able to assist you much with community-made guides. Feel free to check th
         />
       </svg>
     }
-    title="Syntax Highlighting"
-    href="/docs/guide/syntax-highlighting"
+    title="Community Guides"
+    href="/community-guides"
   />
-  <Card
-    icon={
-      <svg
-        xmlns="http://www.w3.org/2000/svg"
-        fill="none"
-        viewBox="0 0 24 24"
-        strokeWidth={1.5}
-        stroke="currentColor"
-        className="h-6 w-6"
-      >
-        <path
-          strokeLinecap="round"
-          strokeLinejoin="round"
-          d="M9.813 15.904L9 18.75l-.813-2.846a4.5 4.5 0 00-3.09-3.09L2.25 12l2.846-.813a4.5 4.5 0 003.09-3.09L9 5.25l.813 2.846a4.5 4.5 0 003.09 3.09L15.75 12l-2.846.813a4.5 4.5 0 00-3.09 3.09zM18.259 8.715L18 9.75l-.259-1.035a3.375 3.375 0 00-2.455-2.456L14.25 6l1.036-.259a3.375 3.375 0 002.455-2.456L18 2.25l.259 1.035a3.375 3.375 0 002.456 2.456L21.75 6l-1.035.259a3.375 3.375 0 00-2.456 2.456zM16.894 20.567L16.5 21.75l-.394-1.183a2.25 2.25 0 00-1.423-1.423L13.5 18.75l1.183-.394a2.25 2.25 0 001.423-1.423l.394-1.183.394 1.183a2.25 2.25 0 001.423 1.423l1.183.394-1.183.394a2.25 2.25 0 00-1.423 1.423z"
-        />
-      </svg>
-    }
-    title="Syntax Highlighting"
-    href="/docs/guide/syntax-highlighting"
-  />
-  <Card
-    icon={
-      <svg
-        xmlns="http://www.w3.org/2000/svg"
-        fill="none"
-        viewBox="0 0 24 24"
-        strokeWidth={1.5}
-        stroke="currentColor"
-        className="h-6 w-6"
-      >
-        <path
-          strokeLinecap="round"
-          strokeLinejoin="round"
-          d="M9.813 15.904L9 18.75l-.813-2.846a4.5 4.5 0 00-3.09-3.09L2.25 12l2.846-.813a4.5 4.5 0 003.09-3.09L9 5.25l.813 2.846a4.5 4.5 0 003.09 3.09L15.75 12l-2.846.813a4.5 4.5 0 00-3.09 3.09zM18.259 8.715L18 9.75l-.259-1.035a3.375 3.375 0 00-2.455-2.456L14.25 6l1.036-.259a3.375 3.375 0 002.455-2.456L18 2.25l.259 1.035a3.375 3.375 0 002.456 2.456L21.75 6l-1.035.259a3.375 3.375 0 00-2.456 2.456zM16.894 20.567L16.5 21.75l-.394-1.183a2.25 2.25 0 00-1.423-1.423L13.5 18.75l1.183-.394a2.25 2.25 0 001.423-1.423l.394-1.183.394 1.183a2.25 2.25 0 001.423 1.423l1.183.394-1.183.394a2.25 2.25 0 00-1.423 1.423z"
-        />
-      </svg>
-    }
-    title="Syntax Highlighting"
-    href="/docs/guide/syntax-highlighting"
-  />
-</Cards>