diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:06:43 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-19 05:08:00 +0300 |
| commit | ee6a8f9411a3d8f0105ed5d793bc44dafcd9ce2b (patch) | |
| tree | a1c5fb333e701261160fd37f144e3b8a0c3fefa1 /CONTRIBUTING.md | |
| parent | c5e1a20ad30f400a951abe154385d8f5931bebf3 (diff) | |
docs: move public references to website docs
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 2 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b4d6d9d..a79aa29b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,16 +50,9 @@ If you plan to implement the change yourself, say that directly in the issue and ## Documentation for unreleased changes -The root docs describe the latest released version of herdr. Do not update root `README.md`, `CONFIGURATION.md`, `INTEGRATIONS.md`, `SOCKET_API.md`, or `CHANGELOG.md` for normal PRs. +The root `README.md`, root `CHANGELOG.md`, and website docs describe the latest released version of herdr. Do not update root `README.md`, root `CHANGELOG.md`, or `website/src/content/docs/` for normal PRs. -If your PR changes user-facing behavior, update the matching next-release docs under `docs/next/` instead. - -Examples: - -- config changes: update `docs/next/CONFIGURATION.md` -- integration changes: update `docs/next/INTEGRATIONS.md` -- socket/API changes: update `docs/next/SOCKET_API.md` -- workflow or usage changes: update `docs/next/README.md` +If your PR changes user-facing behavior, mention the needed public-doc update in the PR. Update `docs/next/README.md` only when the root README needs to change for the next release. You do not need to edit the changelog for normal PRs. Maintainers prepare `docs/next/CHANGELOG.md` during release review. |