Skip to content

Commit 7486a9d

Browse files
docs: add support
1 parent 55f4d9f commit 7486a9d

6 files changed

Lines changed: 42 additions & 9 deletions

File tree

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ LizardByte only supports the latest version of our software.
66

77
## Reporting a Vulnerability
88

9-
If you think you have found a security vulnerability in our software, please report it to us using the "Security" tab
10-
on the GitHub repository.
9+
If you think you have found a security vulnerability in our software, please report it to us privately using the
10+
"Security" tab on the GitHub repository.
1111

1212
After you have submitted the vulnerability, we will review the report internally and respond to you with
1313
any questions or next steps.

SUPPORT.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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+
## Getting Support
8+
9+
**First, read the documentation!** Many common questions are answered in our comprehensive docs.
10+
11+
| Platform | Support Type | Description |
12+
|----------------------------------------------------------------------------|-----------------------|----------------------------------------|
13+
| 📖 [Read the Docs](https://docs.lizardbyte.dev/latest/about/overview.html) | **Documentation** | Official documentation and guides |
14+
| 💬 [Discord](https://discord.com/invite/d6MpcrbYQs) | **Primary Support** | Real-time chat support |
15+
| 🐙 [GitHub Discussions](https://github.com/orgs/LizardByte/discussions) | **Primary Support** | Feature requests and general discourse |
16+
| 👽 [Reddit](https://www.reddit.com/r/LizardByte) | **Community Support** | Community-driven support |
17+
18+
## Additional Resources
19+
20+
- 🏠 [Homepage](https://app.lizardbyte.dev/)
21+
- 🔧 [Status Page](https://status.LizardByte.dev)
22+
- 📝 [Blog](https://app.lizardbyte.dev/blog)
23+
- 🗺️ [Roadmap](https://app.lizardbyte.dev/roadmap)
24+
25+
## Support Guidelines
26+
27+
When seeking support, please:
28+
29+
1. **Read the documentation first** - Many common questions are already answered in docs
30+
2. **Use the appropriate channel** - Each platform has multiple channels/categories for support,
31+
select the one that best fits your question
32+
3. **Be courteous and respectful** - Follow community guidelines and be patient with volunteers
33+
4. **Provide detailed information** - Include logs, error messages, and system information when relevant
34+
5. **Use proper formatting** - Help others help you by formatting code and logs properly
35+
6. **Do not cross post** - Please avoid posting the same question in multiple places

docs/source/about/support.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../SUPPORT.md
2+
```

docs/source/about/support.rst

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

docs/source/developers/security.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../../../SECURITY.md
2+
```

docs/source/toc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@
1919
developers/code_of_conduct
2020
developers/contributing
2121
developers/repository_standards
22+
developers/security

0 commit comments

Comments
 (0)