enhance(development): improve issue-report routing by component

Clarify where users should file feature requests and bug reports across Pangolin, Newt, Gerbil, and Olm to improve direction and reduce misfiled issues.
This commit is contained in:
Laurence
2026-02-09 10:37:03 +00:00
parent df9b36cbe0
commit 09dad9c4db

View File

@@ -3,15 +3,31 @@ title: "Feature Requests & Bug Reports"
description: "How to submit feature requests and report bugs for Pangolin"
---
We welcome contributions from the community to help improve Pangolin. To ensure your feedback is properly tracked and prioritized, please use the appropriate GitHub sections for different types of submissions.
We welcome contributions from the community to help improve Pangolin. To ensure your feedback is properly tracked and prioritized, use the repository that matches the component where your issue or request belongs.
## Pick the Right Repository
Pangolin is made up of multiple components. To get the fastest response, file your request or bug report in the repository that matches the component you're using.
<CardGroup cols={2}>
<Card title="Feature Requests" icon="lightbulb">
Submit in GitHub Discussions for community feedback and upvoting
<Card title="Pangolin" icon="server" href="https://github.com/fosrl/pangolin">
Dashboard and core platform.
[Discussions](https://github.com/fosrl/pangolin/discussions) and [Issues](https://github.com/fosrl/pangolin/issues).
</Card>
<Card title="Bug Reports" icon="bug">
Submit in GitHub Issues for tracking and resolution
<Card title="Newt" icon="plug" href="https://github.com/fosrl/newt">
Site and network connector.
[Issues](https://github.com/fosrl/newt/issues).
</Card>
<Card title="Gerbil" icon="circle-nodes" href="https://github.com/fosrl/gerbil">
WireGuard interface management service.
[Issues](https://github.com/fosrl/gerbil/issues).
</Card>
<Card title="Olm" icon="desktop" href="https://github.com/fosrl/olm">
Client tunnel connector for Newt sites.
[Issues](https://github.com/fosrl/olm/issues).
</Card>
</CardGroup>
@@ -30,7 +46,14 @@ Feature requests with community support (upvotes and positive feedback) are more
## Bug Reports
Bug reports should be submitted in the [GitHub Issues section](https://github.com/fosrl/pangolin/issues) for proper tracking and resolution. This ensures:
Bug reports should be submitted in GitHub Issues for the relevant repository:
- **Pangolin**: [fosrl/pangolin/issues](https://github.com/fosrl/pangolin/issues)
- **Newt**: [fosrl/newt/issues](https://github.com/fosrl/newt/issues)
- **Gerbil**: [fosrl/gerbil/issues](https://github.com/fosrl/gerbil/issues)
- **Olm**: [fosrl/olm/issues](https://github.com/fosrl/olm/issues)
Using the correct repo ensures:
- **Proper tracking** of bugs through their lifecycle
- **Developer visibility** for quick resolution