Add docs link to PR comment (#478)

Author: flying-sheep

.github/workflows/deploy-instance-repo.yml

@@ -133,13 +133,17 @@ jobs:
         uses: mshick/add-pr-comment@v2
         with:
           message: |
-            A PR has been generated to the instance repo:
-            https://github.com/${{ env.INSTANCE_REPO_GITHUB }}/pull/${{ env.SISTER_PR_ID }}
+            A PR has been generated to the instance repo: ${{ env.INSTANCE_REPO_GITHUB }}#${{ env.SISTER_PR_ID }}
 
+            [![Checks Status][checks-badge]][checks] [![Documentation Preview][docs-badge]][docs]
 
-            You can check out the PR to preview your changes
-            in an instance of the cookiecutter template. The PR will be kept in sync with
-            this PR automatically.
+            You can check out the PR to preview your changes in an instance of the cookiecutter template.
+            It will be kept in sync with this PR automatically.
+
+            [checks-badge]: https://github.com/scverse/cookiecutter-scverse-instance/actions/workflows/test.yaml/badge.svg?branch=pr-${{ github.event.pull_request.number }}
+            [checks]: https://github.com/scverse/cookiecutter-scverse-instance/pull/${{ env.SISTER_PR_ID }}/checks
+            [docs-badge]: https://app.readthedocs.org/projects/cookiecutter-scverse-instance/badge/?version=${{ env.SISTER_PR_ID }}
+            [docs]: https://cookiecutter-scverse-instance--${{ env.SISTER_PR_ID }}.org.readthedocs.build/
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           allow-repeats: false