added codespell and review workflows (#21)

* added codespell and review workflows

* typos

* no bikeshed used

* fixed repo name for review URL

Author: jo-mueller

.github/workflows/codespell.yml

@@ -0,0 +1,23 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

.github/workflows/review.yml

@@ -0,0 +1,25 @@
+---
+name: Add review url
+
+on:
+  pull_request_target:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/find-comment@v2
+        id: fc
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          comment-author: 'github-actions[bot]'
+          body-includes: Automated Review URLs
+
+      - uses: peter-evans/create-or-update-comment@v2
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            #### Automated Review URLs
+            * [Readthedocs](https://ngff-spec--${{ github.event.pull_request.number }}.org.readthedocs.build/)
+          edit-mode: replace

ngff_spec/citing.md

@@ -6,7 +6,7 @@ Citing
 J. Moore, *et al*. Open Microscopy Environment Consortium, 8 February 2022.
 
 This edition of the specification is [https://ngff.openmicroscopy.org/{{version}}](https://ngff.openmicroscopy.org/{{version}}]).
-The latest edition is publically available {cite}`ngff_spec_latest`.
+The latest edition is publicly available {cite}`ngff_spec_latest`.
 
 ```{bibliography}
 :style: unsrt

ngff_spec/contribute.md

@@ -10,7 +10,7 @@ Major changes should follow the RFC process as it was laid out in [RFC1](https:/
 ## Building the documentation
 
 Build and inspect changes to the documentation before submitting a PR.
-To do so, you first need to install the necessary dependecies:
+To do so, you first need to install the necessary dependencies:
 
 ```bash
 pip install -r requirements.txt
@@ -33,18 +33,18 @@ You'll find the built webpages under `_build/html`.
 Contributions should conform to [Semantic Line Breaks (SemBr)](https://sembr.org/),
 to improve change tracking.
 
-### Formating hints
+### Formatting hints
 
 The specification uses MyST extensively for a number of formatting options
-to make the text readible and improve structure.
+to make the text readable and improve structure.
 
 #### Referencing
 
 MyST allows a number of ways to reference and cross-reference inside this text
 and across several of the pages in this repo.
 For an overview of supported referencing syntax,
 see the [MyST doc pages](https://mystmd.org/guide/cross-references).
-It is recommended to use the following syntax in this document for consitency:
+It is recommended to use the following syntax in this document for consistency:
 
 ```
 anchor: (your-reference-name)=

pre_build.py

@@ -92,7 +92,7 @@ def build_json_schemas():
                 config=config_md
             )
 
-            # insert mySt crossreference at top of markdown files
+            # insert mySt cross-reference at top of markdown files
             with open(output_path_md, 'r') as md_file:
                 md_content = md_file.read()
             crossref = f"(schemas:{Path(schema_file).stem})"