Skip to content

Commit 827e46d

Browse files
committed
Update contributing guide for new release notes system
1 parent 24708e1 commit 827e46d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/developers/contributing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ The documentation consists both of prose and API documentation. All user-facing
216216
and functions are included in the API documentation, under the ``docs/api`` folder
217217
using the `autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_
218218
extension to sphinx. Any new features or important usage information should be included in the
219-
user-guide (``docs/user-guide``). Any changes should also be included in the release
220-
notes (``docs/release-notes.rst``).
219+
user-guide (``docs/user-guide``). Any changes should also be included as a new file in the
220+
:file:`changes` directory.
221221

222222
The documentation can be built locally by running::
223223

@@ -350,7 +350,7 @@ appropriate suffix (e.g. `v0.0.0a1` or `v0.0.0rc2`).
350350

351351
Set the description of the release to::
352352

353-
See release notes https://zarr.readthedocs.io/en/stable/release.html#release-0-0-0
353+
See release notes https://zarr.readthedocs.io/en/stable/release-notes.html#release-0-0-0
354354

355355
replacing the correct version numbers. For pre-release versions,
356356
the URL should omit the pre-release suffix, e.g. "a1" or "rc1".

0 commit comments

Comments
 (0)