ci: add documentation test

Author: mcquenji

.github/workflows/doc.yaml

@@ -0,0 +1,30 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Doc Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📚 Checkout code
+        uses: actions/checkout@v3
+
+      - name: 🐦 Set up Dart
+        uses: dart-lang/setup-dart@v1
+        with:
+          sdk: stable
+
+      - name: 📦 Install dependencies
+        run: dart pub get
+
+      - name: 🔍 Generate Docs
+        run: dart doc --dry-run
+      

dartdoc_options.yaml

@@ -29,3 +29,5 @@ dartdoc:
       markdown: lib/src/shared/README.md
   categoryOrder: [Shared Primitives, Modules,Presentation Layer, Repositories, Routing, Caching, Persistence, Transactions, Telemetry & Analytics]
   showUndocumentedCategories: true
+  errors:
+    - unresolved-doc-reference