Skip to content

Commit 047ee4f

Browse files
committed
Add Discord Rules
1 parent 7924915 commit 047ee4f

File tree

3 files changed

+81
-14
lines changed

3 files changed

+81
-14
lines changed

docs/discord-server/index.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: 'Discord Server'
3+
description: 'All about our discord server community'
4+
slug: 'discord-server'
5+
---
6+
7+
We are a diverse community of graphics programming enthusiasts from humble hobbyists to full-on professionals, with all levels of mastery of Vulkan, Direct3D, OpenGL, etc!
8+
We love answering interesting questions and trying to solve graphics-related problems; we hope you join in on the fun, whether by asking your own questions or answering others’, or sharing your adventures in the graphics programming world.
9+
10+
## Rules
11+
12+
- Be nice and respectful.
13+
- When you ask a question:
14+
a. Don't ask if you can ask, just ask (in the appropriate channel)
15+
b. Debug the issue yourself first to the best of your ability, using renderdoc if possible: https://renderdoc.org/docs/getting_started/quick_start.html
16+
c. Explain your issue in detail. “it doesn’t work” is not a sufficient problem description
17+
d. Explain what you've tried already
18+
e. Support your question with code/screenshots/renderdoc captures if possible
19+
f. Simplify code to only what’s relevant to your question, don't post screenshots of code, remember you can format code on discord
20+
g. Be patient and don't crosspost if you don't get an immediate response
21+
h. Don’t ask for help with LLM output (e.g. ChatGPT)
22+
- Don't ask us to do your homework for you.
23+
- Don't send links using URL shorteners.
24+
- Any form of advertisement must be cleared with moderators first. This includes invite links to other discord servers. Crypto, NFT and web3 posts are never allowed.
25+
- Do not discuss or distribute illegal content (even if leaked by a third party), hacking or cheating technologies, no discussing modifying existing games (games with actual official mod support are allowed), or post gory or otherwise disturbing imagery.
26+
- Keep discussions on-topic
27+
- No discussion of politics, religion, etc. in any channels
28+
- No usernames/nicknames that are website links or allude to website links
29+
30+
## Infractions
31+
32+
Disruptive behavior will result in warnings or bans:
33+
34+
- Warning (lasts 3 days)
35+
- Last warning (lasts 7 days)
36+
- 7-day ban
37+
- Permanent ban
38+
39+
3 strike rule: warnings count as 1 strike, strikes last 3 months, 3 active strikes result in a permaban.
40+
41+
## Roles
42+
43+
We have a few custom roles on our server, some are self-assignable while some are granted by the mods. Head over to ⁠reaction-roles to pick the api, coordinate system, or pronouns of your choosing!
44+
45+
## Community
46+
47+
We have a Github organization where we host:
48+
49+
- Our server mascot good-froge, we like frogs (see #frogshed)
50+
- deccer-cubes, a challenging asset for your renderer; can you handle the cubes? give them a try and report your findings to #"This mesh will crash your engine", you might get a custom role!
51+
- rvpt, a realtime vulkan path tracer project
52+
- A collection of useful graphics programming resources
53+
- this very blog
54+
55+
We also have a website with additional resources and are currently revamping a "screenshot of the month" gallery
56+
57+
We have a few channels for showing off your work or encouraging others to help you think out loud when developing your project:
58+
59+
- `#⁠showcase`, show off your creations (please use threads for discussion)
60+
- `#⁠wip`, similar to showcase, but for incremental progress and discussion thereof
61+
- `#⁠the-bug-collective`, for all your buggy, glitchy renders
62+
- `#⁠community-projects`, the place to think-out-loud/yell/complain/rant/progress/blog about your UE5/starcitizen/minecraft clone
63+
64+
If you have suggestions for how to improve the server, be it new emojis, moderation, channels/categories, let us know by making a post in `⁠#suggestions`.
65+
66+
Enjoy and have fun!

docusaurus.config.ts

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ const config: Config = {
4444
[
4545
'classic',
4646
{
47-
docs: false,
47+
docs: {
48+
routeBasePath: 'docs',
49+
sidebarPath: './sidebars.ts',
50+
},
4851
blog: {
4952
showReadingTime: true,
5053
feedOptions: {
@@ -87,11 +90,11 @@ const config: Config = {
8790
},
8891
items: [
8992
{
90-
href: 'https://github.com/graphicsprogramming',
91-
position: 'right',
92-
className: 'header--github-link',
93-
"aria-label": "GitHub Repository"
94-
}
93+
type: 'docSidebar',
94+
sidebarId: 'discordServer',
95+
position: 'left',
96+
label: 'Discord Server',
97+
},
9598
],
9699
},
97100
footer: {

sidebars.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,18 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
1212
*/
1313
const sidebars: SidebarsConfig = {
1414
// By default, Docusaurus generates a sidebar from the docs folder structure
15-
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
15+
//tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
1616

1717
// But you can create a sidebar manually
1818

19-
/*
20-
tutorialSidebar: [
21-
'intro',
19+
20+
discordServer: [
2221
{
23-
type: 'category',
24-
label: 'Tutorial',
25-
items: ['tutorial-basics/create-a-document'],
22+
type: 'autogenerated',
23+
dirName: 'discord-server'
2624
},
2725
],
28-
*/
26+
2927

3028
};
3129

0 commit comments

Comments
 (0)