diff --git a/README.md b/README.md index c6bbb5e5..83684bf0 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,30 @@ This repository contains assets required to build the [documentation website for We're glad that you want to contribute! +- [Reporting bugs and requesting features](#reporting-bugs-and-requesting-features) - [Contributing to the docs](#contributing-to-the-docs) +## Reporting bugs and requesting features + +NetBird uses a discussion-first workflow across all its repositories. Bug reports and +feature requests for the docs start in +[netbird Discussions](https://github.com/netbirdio/netbird/discussions), not as issues here. + +| What you want to do | Where to go | +| --- | --- | +| Report a bug, regression, or unexpected behavior | [Issue Triage](https://github.com/netbirdio/netbird/discussions/new?category=issue-triage) | +| Request a feature or share an idea | [Ideas & Feature Requests](https://github.com/netbirdio/netbird/discussions/new?category=ideas-feature-requests) | +| Ask about setup, configuration, or self-hosting | [Q&A / Support](https://github.com/netbirdio/netbird/discussions/new?category=q-a-support) | +| Report a security vulnerability | [Security policy](https://github.com/netbirdio/netbird/security/policy), never a public thread | + +Our team triages each discussion. Validated reports become issues in this repository, +linked back to the discussion. See +[How to use Discussions, Issues, and Pull Requests](https://github.com/netbirdio/netbird/discussions/6075) +for the full workflow. + +Small fixes like typos, broken links, or documentation corrections can go straight to a +[pull request](#contributing-to-the-docs). + ### Requirements * node 16 * npm 8+