Skip to content

Commit df388a3

Browse files
docs: add support
1 parent c642786 commit df388a3

2 files changed

Lines changed: 68 additions & 0 deletions

File tree

SUPPORT.md

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

docs/source/about/support.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@ Support
55
Spamming the GitHub repo or organization will result in a ban.
66

77
Our available support methods are listed in our `Support Center <https://app.lizardbyte.dev/support>`__.
8+
9+
.. include:: ../../../SUPPORT.md
10+
:parser: myst_parser.docutils_

0 commit comments

Comments
 (0)