Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ LizardByte only supports the latest version of our software.

## Reporting a Vulnerability

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

After you have submitted the vulnerability, we will review the report internally and respond to you with
any questions or next steps.
Expand Down
35 changes: 35 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Support

> [!WARNING]
> We use GitHub issues exclusively for actionable bug reports. Low-effort issues will be immediately closed.
> Spamming the GitHub repo or organization will result in a ban.

## Getting Support

**First, read the documentation!** Many common questions are answered in our comprehensive docs.

| Platform | Support Type | Description |
|----------------------------------------------------------------------------|-----------------------|----------------------------------------|
| 📖 [Read the Docs](https://docs.lizardbyte.dev/latest/about/overview.html) | **Documentation** | Official documentation and guides |
| 💬 [Discord](https://discord.com/invite/d6MpcrbYQs) | **Primary Support** | Real-time chat support |
| 🐙 [GitHub Discussions](https://github.com/orgs/LizardByte/discussions) | **Primary Support** | Feature requests and general discourse |
| 👽 [Reddit](https://www.reddit.com/r/LizardByte) | **Community Support** | Community-driven support |

## Additional Resources

- 🏠 [Homepage](https://app.lizardbyte.dev/)
- 🔧 [Status Page](https://status.LizardByte.dev)
- 📝 [Blog](https://app.lizardbyte.dev/blog)
- 🗺️ [Roadmap](https://app.lizardbyte.dev/roadmap)

## Support Guidelines

When seeking support, please:

1. **Read the documentation first** - Many common questions are already answered in docs
2. **Use the appropriate channel** - Each platform has multiple channels/categories for support,
select the one that best fits your question
3. **Be courteous and respectful** - Follow community guidelines and be patient with volunteers
4. **Provide detailed information** - Include logs, error messages, and system information when relevant
5. **Use proper formatting** - Help others help you by formatting code and logs properly
6. **Do not cross post** - Please avoid posting the same question in multiple places
2 changes: 2 additions & 0 deletions docs/source/about/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../../SUPPORT.md
```
7 changes: 0 additions & 7 deletions docs/source/about/support.rst

This file was deleted.

2 changes: 2 additions & 0 deletions docs/source/developers/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../../SECURITY.md
```
1 change: 1 addition & 0 deletions docs/source/toc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@
developers/code_of_conduct
developers/contributing
developers/repository_standards
developers/security