Skip to content

Commit 3e313d6

Browse files
committed
Basic docs (W.I.P.)
1 parent c05cea3 commit 3e313d6

35 files changed

+633
-1115
lines changed

blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.
Binary file not shown.

blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

blog/authors.yml

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1-
yangshun:
2-
name: Yangshun Tay
3-
title: Front End Engineer @ Facebook
4-
url: https://github.com/yangshun
5-
image_url: https://github.com/yangshun.png
6-
page: true
1+
59L:
2+
name: 59L
3+
title: Project Leader
4+
url: https://github.com/59L
5+
image_url: https://avatars.githubusercontent.com/u/60123007?v=4
6+
page:
7+
# customize the url of the author page at /blog/authors/<permalink>
8+
permalink: '/59l'
79
socials:
8-
x: yangshunz
9-
github: yangshun
10+
github: 59L
1011

11-
slorber:
12-
name: Sébastien Lorber
13-
title: Docusaurus maintainer
14-
url: https://sebastienlorber.com
15-
image_url: https://github.com/slorber.png
12+
simonb50:
13+
name: SimonB50
14+
title: Project Maintainer
15+
url: https://github.com/SimonB50
16+
image_url: https://avatars.githubusercontent.com/u/40821945?v=4
1617
page:
1718
# customize the url of the author page at /blog/authors/<permalink>
18-
permalink: '/all-sebastien-lorber-articles'
19+
permalink: '/simonb50'
1920
socials:
20-
x: sebastienlorber
21-
linkedin: sebastienlorber
22-
github: slorber
23-
newsletter: https://thisweekinreact.com
21+
github: SimonB50
22+
website: https://simonb50.xyz

blog/tags.yml

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,4 @@
1-
facebook:
2-
label: Facebook
3-
permalink: /facebook
4-
description: Facebook tag description
5-
6-
hello:
7-
label: Hello
8-
permalink: /hello
9-
description: Hello tag description
10-
11-
docusaurus:
12-
label: Docusaurus
13-
permalink: /docusaurus
14-
description: Docusaurus tag description
15-
16-
hola:
17-
label: Hola
18-
permalink: /hola
19-
description: Hola tag description
1+
release:
2+
label: Release
3+
permalink: /releases
4+
description: Release notes for the latest versions of BryanBot.

docs/community/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Community",
3+
"position": 3
4+
}

docs/community/addons.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Addons
3+
sidebar_position: 4
4+
---
5+
6+
# Addons
7+
There are multiple types of addons available for BryanBot. They differ in the way they are created, maintained and distributed. Here is a list of the different types of addons available for BryanBot:
8+
9+
## Official Addons
10+
Official addons are created and maintained by the BryanBot team. They are guaranteed to work with the latest version of BryanBot. Compatibility updates are released with every new version of BryanBot.
11+
12+
Currently, there are no official addons available for BryanBot.
13+
14+
## First-party Addons
15+
First-party addons are created by the developers of the BryanBot. They are maintained and frequently updated by the developers. They are not guaranteed to work with the latest version of BryanBot and compatibility updates can be posted later than the release of a new version of BryanBot.
16+
17+
Currently, there are no first-party addons available for BryanBot.
18+
19+
## Third-party Addons
20+
Third-party addons are created by the community. They are not maintained by the BryanBot team and are not guaranteed to work with the latest version of BryanBot or at all. Compatibility updates are released by the developers of the addon.
21+
22+
Currently, there are no third-party addons available for BryanBot.

docs/community/guidelines.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Developer Guidelines
3+
sidebar_position: 2
4+
---
5+
6+
# Community Developer Guidelines
7+
- "We", "Us", "Our" refer to the BryanBot Development Team.
8+
- "You", "Your" refer to the **Community Developers.**
9+
- "Third Party Developers" refer to any developers who are not in contact with us and have not read this document.
10+
11+
> You, for the entirety of the time that you are holding the title and included within the position of **Community Developer**, are bound by this agreement and any direct or indirect violations will have consequences. In case of resigning from the position, you will no longer be bound by this agreement until you will once again be holding the title and included within the position of **Community Developer**.
12+
13+
## Community Developers
14+
1. All resources must be submitted for verification before being published. No exceptions will be made.
15+
2. Do not publicly call out any users or developers in the event of a dispute or conflict between two parties. Contact BryanBot staff instead.
16+
3. You are not allowed to publish addons explicitly made by another third-party developer under any conditions.
17+
18+
## Resources Submitted
19+
1. Submitted resources may not contain any piece of code with the intention of benefiting the developer from the user's hardware or software.
20+
2. All submitted resources must consist primarily of your code. If you are found to be plagiarizing code from elsewhere, we reserve the right to remove you from the position of a **Community Developer**. You are allowed to use third-party or licensed code if permission is granted, but you are required to disclose that you have used code from a third party and the original author of the used code.
21+
- You are not allowed to publish addons explicitly created by a third-party developer, regardless of your connection to them.
22+
- You are responsible for the safety and security of any third-party code you have included in your addons.
23+
3. You are responsible for keeping your codebase clean and free of bugs for the duration of your holding the title of **Community Developer**. Any unmaintained addons must be strictly disclosed to be unmaintained and therefore possibly prone to bugs and/or vulnerabilities.
24+
25+
## Publishing resources
26+
1. Add verified resource should be published on the <u>verified marketplace</u>.
27+
- You are able to request verification of any platform you want to publish your resources on.
28+
2. All threads for verified resources should include official branding for verified work.
29+
- You are not allowed to use verified branding on resources that were not verified by BryanBot staff even if you are **Community Developer**.
30+
3. All published resources need to clearly state that they are made for BryanBot along with link to the official GitHub repository of the project.
31+
32+
## Our Rights
33+
1. We reserve the right to remove you from the position of a **Community Developer** anytime, for any reason.
34+
- Needless to say, we will always provide proper reasoning, but you must keep in mind that we do hold the right to do so.
35+
2. We hold the right to investigate your code without prior notice, for any reason, and you are obliged to respond positively. Exceptions will be handled on a case-by-case basis.
36+
37+
## Your Rights
38+
1. You, naturally, reserve the right to resign from your position as **Community Developer**, forfeiting all benefits coming from said position.
39+
2. While BryanBot Development Team is fitting the definition of organizations engaged in **professional or commercial activity** as stated by the GDPR, <u>we do not</u> collect any data from our users for commercial purposes and therefore are not bound by GDPR; however, you, as a **Community Developer**, are unofficially eligible for requesting your data.
40+
3. You may inquire about the usage of collected information and how it is processed, anytime for any reason.
41+
4. You get to object to any of the lines within this document with proper reasoning provided, as well as to request changes; however, you must keep in mind that:
42+
- We may veto your objections.
43+
- Refuse to make any changes,
44+
5. All sales you make will be collected entirely by you; we will not intervene with the funds received by you.

docs/community/info.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: About
3+
sidebar_position: 1
4+
---
5+
6+
# BryanBot Community
7+
BryanBot is a community-driven project. We are always looking for ways to improve the bot and to make it more accessible for the community. This page is dedicated to the community and the developers who are contributing to the project.
8+
9+
## Community Support
10+
We have a [dedicated server for the BryanBot community](https://discord.gg/GvyuDDFeZU). If you have any questions, suggestions, or need help with the bot, feel free to join the server and ask for help. Our support team is always ready to help you with any issues you might have.
11+
12+
## Community Developers
13+
We are focused on development made by the community. While we do not limit the independent development for the bot, we do run **Verified Community Developers** program. This program is designed to help developers to get their work recognized and to help them to get more users for their projects.
14+
15+
### Joining the Program
16+
In order to join the program, you need to submit at least one resource for verification. More about the verification process can be found in the section below.
17+
18+
### Addon Verification
19+
Verification is a process where we check the submitted resources for any malicious code, bugs, or other issues. We also check if the resource is following the guidelines set by the BryanBot Development Team. If the resource passes the verification process, it will be marked as verified and the developer will get the verified badge.
20+
21+
#### Verification Process
22+
1. **Submit the resource** - You need to submit the resource for verification. You can do this through the [support server](https://discord.gg/GvyuDDFeZU).
23+
2. **Verification** - We will check the resource for any issues. If the resource passes the verification process, it will be marked as verified.
24+
3. **Publishing** - After the resource is verified, you can publish it on the verified marketplace.
25+
26+
### Publishing Resources
27+
After resource verification, you can publish the resource on one of the verified marketplaces. More information about that can be found [here](/docs/community/marketplaces).

docs/community/marketplaces.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Verified Marketplaces
3+
sidebar_position: 3
4+
---
5+
6+
# Verified Marketplaces
7+
Verified addons made by **Community Developers** can only be published on the verified marketplaces.
8+
This is to ensure that both users and developers are safe from any malicious code or other issues.
9+
10+
## Verified Marketplaces
11+
- [BuiltByBit](https://builtbybit.com/)
12+
13+
## Requesting marketplace verification
14+
If you are a **Community Developer** and want to publish your resources on a marketplace that is not verified or you own/represent a marketplace that you want to get verified, you can request verification by contacting the BryanBot staff.
15+
16+
### Requirements
17+
- The marketplace must have a clear and easy-to-understand terms of service and privacy policy.
18+
- It needs to operate for at least 6 months.
19+
- Interface must be user-friendly and easy to navigate.
20+
- The marketplace must have a system in place to handle disputes between users and developers.
21+
- It must be handled by a registered company or individual.
22+
23+
## Other approved platforms
24+
You are allowed to publish your resources on the following platforms:
25+
- [GitHub](https://github.com/)
26+
- Your Discord server

docs/development/_category_.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Development",
3+
"position": 4
4+
}

docs/development/introduction.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Introduction
3+
sidebar_position: 1
4+
---
5+
6+
# Introduction
7+
8+
:::danger Work in progress
9+
10+
This section is still a work in progress. If you have any questions, feel free to ask in the [Discord server](https://discord.gg/bryanbot).
11+
12+
:::

docs/intro.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

docs/setup/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Setup",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn how to set up your bot in a few simple steps."
7+
}
8+
}

0 commit comments

Comments
 (0)