@@ -31,11 +31,18 @@
3131
3232* _Documentation_:
3333
34− * README is updated, links in README are stable. Run `rg '/blob/'`
35− and `rg '/tree/'` to search for github links, replace `master` ref
36− with release tag where possible (e.g. streamly-examples). Ideally,
37− the distribution process should automatically replace these with
38− current stable references.
34+ * README is updated.
35+ * Check if all the links in the README are stable.
36+ * External links might point to the `master` branch of a few
37+ repositories. Pin them to a specific version that works with the current
38+ release.
39+ * You can run `rg '/blob/'` and `rg '/tree/'` to search for github links.
40+ * For example, links that point to `streamly-examples` point to its
41+ `master` branch. Instead, while making the release we need to pin the
42+ links to a specific revision that works with the latest commit of the
43+ current release.
44+ * Ideally, the distribution process should automatically replace these
45+ with current stable references.
3946 * Haddock docs are consistent with the changes in the release
4047 * Tutorial has been updated for new changes
4148 * Documents in the `docs` directory are consistent with new changes