Skip to content

Commit c028a5d

Browse files
docs: add support
1 parent c642786 commit c028a5d

2 files changed

Lines changed: 73 additions & 7 deletions

File tree

SUPPORT.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Support
2+
3+
> [!WARNING]
4+
> We use GitHub issues exclusively for actionable bug reports. Low-effort issues will be immediately closed.
5+
> Spamming the GitHub repo or organization will result in a ban.
6+
7+
## Need support?
8+
9+
**First, read the documentation!**
10+
11+
### Read the Docs
12+
13+
Select projects have the documentation hosted on Read the Docs. Otherwise, check the project's README file.
14+
15+
**Type:** Documentation
16+
17+
📖 [Read the Docs](https://docs.lizardbyte.dev/latest/about/overview.html)
18+
19+
---
20+
21+
## Need more help?
22+
23+
**Ask questions**
24+
25+
### Discord
26+
27+
This is our preferred method of providing support!
28+
Please read the rules, be courteous, and use the appropriate channel when posting.
29+
30+
**Type:** Primary Support
31+
32+
💬 [Join our Discord](https://discord.com/invite/d6MpcrbYQs)
33+
34+
### GitHub
35+
36+
GitHub *Discussions* are available for support, feature requests, and general discourse.
37+
Please DO NOT use GitHub issues to ask for support!
38+
39+
**Type:** Primary Support
40+
41+
🐙 [GitHub Discussions](https://github.com/orgs/LizardByte/discussions)
42+
43+
### Reddit
44+
45+
For aliens only! Please read the rules, be courteous, and use the appropriate flair when posting.
46+
Provide your logs when asking for help.
47+
48+
**Type:** Community Support
49+
50+
👽 [r/LizardByte](https://www.reddit.com/r/LizardByte)
51+
52+
---
53+
54+
## Additional Resources
55+
56+
- 📚 [Documentation](https://docs.lizardbyte.dev/latest/about/overview.html)
57+
- 🏠 [Homepage](https://app.lizardbyte.dev/)
58+
- 🔧 [Status Page](https://status.LizardByte.dev)
59+
- 📝 [Blog](https://app.lizardbyte.dev/blog)
60+
61+
---
62+
63+
## Support Guidelines
64+
65+
When seeking support, please:
66+
67+
1. **Read the documentation first** - Many common questions are answered in our comprehensive docs
68+
2. **Use the appropriate channel** - Discord and GitHub Discussions for primary support, Reddit for community support
69+
3. **Be courteous and respectful** - Follow community guidelines and be patient with volunteers
70+
4. **Provide detailed information** - Include logs, error messages, and system information when relevant
71+
5. **Use proper formatting** - Help others help you by formatting code and logs properly

docs/source/about/support.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,2 @@
1-
Support
2-
=======
3-
4-
.. Warning:: We use GitHub issues exclusively for actionable bug reports. Low effort issues will be immediately closed.
5-
Spamming the GitHub repo or organization will result in a ban.
6-
7-
Our available support methods are listed in our `Support Center <https://app.lizardbyte.dev/support>`__.
1+
.. include:: ../../../SUPPORT.md
2+
:parser: myst_parser.docutils_

0 commit comments

Comments
 (0)