@@ -31,11 +31,18 @@
32* _Documentation_:
32* _Documentation_:
34− * README is updated, links in README are stable. Run `rg '/blob/'`
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
35− and `rg '/tree/'` to search for github links, replace `master` ref
39+ * You can run `rg '/blob/'` and `rg '/tree/'` to search for github links.
36− with release tag where possible (e.g. streamly-examples). Ideally,
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
37− the distribution process should automatically replace these with
44+ * Ideally, the distribution process should automatically replace these
38− current stable references.
45+ with current stable references.
39 * Haddock docs are consistent with the changes in the release
46 * Haddock docs are consistent with the changes in the release
40 * Tutorial has been updated for new changes
47 * Tutorial has been updated for new changes
41 * Documents in the `docs` directory are consistent with new changes
48 * Documents in the `docs` directory are consistent with new changes