Skip to content

FAQ page review and a few other fixes #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: testing
Choose a base branch
from
Open
Binary file added .gitbook/assets/ProfilePicture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 31 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This repository hosts the official documentation, that can be comfortably viewed on [GitBook](https://moonlightbot.gitbook.io/docs/). Commits to the `main` branch update the documentation on the site instantly.

To ensure the highest standard of quality, all contributions must come in forms of pull requests directed to the `testing` branch. Said branch is connected to [a pre-testing GitBook space](https://moonlightbot.gitbook.io/moonlightbot-documentation-preview/), to see if in the field everything works as intended before merging into `main`.
To ensure the highest standard of quality, all contributions must come in forms of pull requests directed to the `testing` branch. Said branch is connected to [a pre-testing GitBook space](https://moonlightbot.gitbook.io/beta/), to see if in the field everything works as intended before merging into `main`.

## Project structure

Expand Down Expand Up @@ -38,6 +38,36 @@ Tabs are boxes of content that show a list of tab titles, and the reader can vie

To start a group of tabs, use the `{% tabs %}` tag. For each single tab, wrap them in `{% tab title="TITLE" %}`, replacing the title accordingly, and `{% endtab %}`. End the whole group of tabs with `{% endtabs %}`.

## Style Guide

* _Always_ add a hyperlink to the command's page when mentioned
* Submit pull requests to the testing branch, not the main branch
* Retain as much information as possible while remaining concise.
* It can be a difficult balance at times, but mistakes are ok! Pull requests and the testing branch allow for plenty of feedback and revision
* Add additional relevant information when it is missing or improves the section
* Use info hints for information that is indirectly related
* Structure pages and sections in the order a user would need to set the bot up, then use comfortably, then in order of importance
* I.e., make sure the bot works, then set it to a comfortable language, then continue to moderation set up
* Tables containing specific values, such as the [log names](/advanced/list-of-log-names.md), should be alphabetical
* Command options are listed in the order they appear in Discord, with required ones going first and optional ones after
* Keep the main page as a summary/overview; Add the specifics of a command or feature to the dedicated/relevant page
* New pages need to be added to [SUMMARY.md](/SUMMARY.md), with command pages being sorted alphabetically

Don't forget to communicate! Ask questions and make suggestions. It's ok to be wrong; Learn and try again, we love it! Additionally, your way of thinking might not be immediately clear to others, but that doesn't immediately make it wrong; Even if it's just a gut feeling, let us know why you made the suggestion you did!

### Screenshots

* Add screenshots where relevant, clarifying, needed, etc.
* Use the standardized profile. This is an imitation of the bot owner's profile to maintain professionalism, and is done with her consent.
* Set your display name to `MoonlightCapital`
* Set your profile picture to [this image](/.gitbook/assets/ProfilePicture.png)
* Add a role with the color `#008080` to yourself and the bot
* Compress screenshots (but don't lose quality); [ImageCompressor](https://imagecompressor.com/) is suitable for this
* Keep the outer margins/blank space of screenshots uniform
* Edit out dates, hovered message options, and other visual discrepancies in screenshots
* Use the "Ash" theme, with default spacing/font size/etc.
* Use the official Discord app/client; Do **not** use a modded Discord client for screenshots

## Commit and branch naming

Try to keep the names of branches and commits meaningful.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ MoonlightBot provides easy and dynamic role management by staff and members alik
* All active temporary roles can be listed with [`/list-temproles`](./role-management-commands/list-temproles.md)
* Roles added to members can be automatically changed to a temporary role using the [`detect-assignment` config option](./management-commands/config.md#roles-detect-assignment)

You can also permanently assign or remove any role to a user with [`/role`](./role-management-commands/role.md), or setup [Reaction Roles](./start-up/setting-up-reaction-roles.md) and [`/selfrole`](./role-management-commands/selfrole.md)s that members can self-assign
You can also permanently assign or remove any role to a user with [`/role`](./role-management-commands/role.md), or setup temporary or permanent [Reaction Roles](./start-up/setting-up-reaction-roles.md) and [`/selfrole`](./role-management-commands/selfrole.md)s that members can self-assign.

## Command Permissions

Expand Down
6 changes: 4 additions & 2 deletions support/premium.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ Activating your subscription is a seamless process that only requires four steps
<figure><img src="/.gitbook/assets/PremiumSuccessfulActivationMessage.png" alt=""><figcaption></figcaption></figure>

3. **Verify the bot is legitimate** by clicking on the bot name to view information. The main instance of MoonlightBot has a verified check mark next to the username and was created on March 18th, 2018. The Premium instance also has a verified check mark next to the username and was created on March 27, 2020!
["MoonlightBot Premium was created on March 27, 2020"](/.gitbook/assets/PremiumMiniProfile.png)

<figure><img src="/.gitbook/assets/PremiumMiniProfile.png" alt="MoonlightBot Premium was created on March 27, 2020"><figcaption>MoonlightBot Premium was created on March 27, 2020</figcaption></figure>

4. If the bot is legitimate, click on the "Add me to your server" button at the end of the confirmation message. Make sure you **do not uncheck** the "View Audit Log" permission in the procedure, as that is required to verify it was you who added the bot and mark you as representative

Done!
Expand Down Expand Up @@ -130,7 +132,7 @@ If you purchased or received a lifetime subscription in the past, it will remain

## Disclaimer

Premium subscribers are subject to the [Resource provider agreement](/policies/acceptable-use-policy.md#6---resource-providerdonation-policy) of the [Acceptable Use Policy](/policies/acceptable-use-policy.md).
Premium subscribers are subject to the [Resource provider agreement](/policies/acceptable-use-policy.md#id-6-resource-provider-donation-policy) of the [Acceptable Use Policy](/policies/acceptable-use-policy.md).

All perks are meant to come "within reason". We will turn down requests that cause excessive strain on our systems, personnel or come with certain caveats that may not be appropriate for our ecosystem. In doubt, consult our Staff first.

Expand Down
3 changes: 2 additions & 1 deletion support/special-thanks.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ They are in charge of administrating MoonlightBot, the server, moderating conver

* 7alisman/TonyM - HF
* NXTCY
* v4ca

### Lifetime Members

Expand Down Expand Up @@ -77,7 +78,7 @@ They are passionate about their native language, and know that not everyone has

* **Danish:** The-God-Of-Noise
* **German:** Darkfinst, I_mundercover, [m]
* **Latin American Spanish:** selffinS, zSnails
* **Latin American Spanish:** selffinS, v4ca, zSnails
* **French:** Michael Ngeleka, tchoupi253, Teren
* **Hindi:** Sai Mehar
* **Korean:** mars
Expand Down
6 changes: 3 additions & 3 deletions support/volunteering.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Their mission is to uncover bugs and annoyances that might hinder a smooth user
* An opportunity to learn how to get the most from MoonlightBot - and many other Discord apps
* Access to and testing of new features as they are developed
* The ability to request small changes, work closely with the developer, and have a voice in important decisions
* Your name on the [Special Thanks Page](/special-thanks.md#testers)
* Your name on the [Special Thanks Page](special-thanks.md#testers)

### Becoming a Tester

Expand All @@ -37,7 +37,7 @@ MoonlightBot translators assist in translating the commands, responses and messa

* A colorful, prominent role in the server to show everyone you're one of us
* MoonlightBot Premium (Basic tier), once you have translated 50 strings
* Your name on the [Special Thanks Page](/special-thanks.md#translators)
* Your name on the [Special Thanks Page](special-thanks.md#translators)

### Becoming a Translator

Expand Down Expand Up @@ -66,7 +66,7 @@ They create new documentation pages as new functions are added to the bot, and u
* A MoonlightBot Premium subscription (Super tier)
* Access to and testing of new features as they are developed
* Earliest possible access to upcoming updates
* Your name on the [Special Thanks Page](/special-thanks.md#documentation-writers)
* Your name on the [Special Thanks Page](special-thanks.md#documentation-writers)

### Becoming a Documentation Writer

Expand Down