Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raidensakura committed Jun 5, 2023
1 parent 561e093 commit 50748fd
Show file tree
Hide file tree
Showing 43 changed files with 1,834 additions and 46 deletions.
10 changes: 7 additions & 3 deletions docs/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
{
"index": "Introduction",
"another": "Another Page",
"advanced": "Advanced (A Folder)",
"about": {
"title": "About",
"type": "page"
},
"installation": "Installing Modmail",
"logviewer-installation": "Installing Logviewer",
"configuration": "Configuring Modmail",
"updating": "Updating Modmail",
"updating-logviewer": "Updating Logviewer",
"setting-up-auto-restart": "Set Up Auto-restart",
"contact": {
"title": "Contact ↗",
"type": "page",
"href": "https://twitter.com/shuding_",
"href": "https://dsc.gg/transience",
"newWindow": true
}
}
3 changes: 0 additions & 3 deletions docs/pages/advanced.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions docs/pages/advanced/satori.mdx

This file was deleted.

31 changes: 0 additions & 31 deletions docs/pages/another.mdx

This file was deleted.

Binary file added docs/pages/assets/bot-id.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/create-bot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/docker-illust.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/docker-image-ls.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/invite-bot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/mongo-connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/mongo-ip.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/mongo-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/mongo-shared.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/reset-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/toggle-intents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/pages/assets/vps-env.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/pages/community-guides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Callout } 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

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.

## [Northflank](https://blog.project-mei.xyz/2023/04/11/hosting-discord-modmail-on-northflank/) Guide by raidensakura

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.
Empty file added docs/pages/configuration.mdx
Empty file.
27 changes: 27 additions & 0 deletions docs/pages/frequently-asked-questions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
description: A list of commonly asked questions or problems related to Modmail.
---

# Frequently Asked Questions

### I tried installing the dependencies with another Python version and it messed up my Pipfile! How can I get the original Pipfile back?

First 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
```

###
4 changes: 3 additions & 1 deletion docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import Image from 'next/image'

# Introduction

Modmail is a self-hosted Discord bot for your server. It works similar to [Reddit](https://reddit.zendesk.com/hc/en-us/articles/210896606-What-is-Modmail-)'s Modmail—both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way.
Expand All @@ -8,7 +10,7 @@ This bot is free for everyone and always will be. If you like this project and w

When a member sends a direct message to Modmail, the bot will create a channel (we call it a "thread") into a designated category. All further DM messages will automatically relay to that channel, then any available staff can respond within the channel. Compared to ticketing bots, Modmail allows easier and more organised discussions among staff.

![](https://i.imgur.com/fru5Q07.png)
<Image src="/header-pic.png" alt="Hello" width={500} height={500} />

Our Logviewer will save the threads so your staff can view previous threads through their corresponding log link. Here is an [example](https://publicmodmail.logs.vodka/logs/example).

Expand Down
Loading

0 comments on commit 50748fd

Please sign in to comment.