Merge pull request #454 from ably/migrate-docs-to-website

docs: trim readme in favour of website documentation
ably · Jan 16, 2025 · 192eed9 · 192eed9
2 parents a1d504c + fec2ae6
commit 192eed9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1,290 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@
 * Provide name of JIRA ticket that this PR is related to (if applicable).
     * e.g. [CHA-101] - this will automatically link the PR to the JIRA ticket.
 * Provide names of any related DRs (if applicable).
-* Provide links to any related PRs
+* Provide links to any related PRs (including documentation)
 
 ### Description
 
@@ -19,7 +19,7 @@
 * [ ] Integration tests created (if applicable).
 * [ ] Follow coding style guidelines found [here](https://github.com/ably/engineering/tree/main/best-practices).
 * [ ] TypeDoc updated (if applicable).
-* [ ] (Optional) Update documentation for new features.
+* [ ] Updated the [website documentation](https://github.com/ably/docs) (if applicable).
 * [ ] Browser tests created (if applicable).
 * [ ] In repo demo app updated (if applicable).