docs: replace stub README, add proper README and CHANGELOG per itpp-standards template

- Rewrote README.md following itpp-standards Section 2.1 template - Updated CHANGELOG.md to standard format - Added .gitea/workflows/docs-check.yml for docs CI
2026-08-09 23:47:12 -04:00
parent 98ea44ef7d
commit d0dcf4c76f
3 changed files with 59 additions and 7 deletions
@@ -0,0 +1,26 @@
+name: Docs Check
+on:
+  push:
+    paths:
+      - '**.md'
+      - 'docs/**'
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Markdown lint
+        run: |
+          npm install -g markdownlint-cli
+          markdownlint '**/*.md' --ignore node_modules
+      - name: Link check
+        run: |
+          npm install -g markdown-link-check
+          find . -name '*.md' -not -path '*/node_modules/*' \
+            -exec markdown-link-check {} \;
+      - name: Spell check
+        run: |
+          pip install codespell
+          codespell '**/*.md' --skip='*.git*'