Inconsistent api documentation

.github/workflows/ci.yml

@@ -77,3 +77,11 @@ jobs:
 
       - name: Check dependencies
         run: cargo deny check
+
+      - name: Check Documentation
+        run: |
+          chmod +x scripts/doc.sh
+          ./scripts/doc.sh
+
+      - name: Lint Documentation (Missing Docs)
+        run: cargo clippy -- -D missing-docs

.github/workflows/pr-validation.yml

@@ -162,7 +162,9 @@ jobs:
                 "$CLIPPY_CHECK" == "true" && \
                 "$TEST_CHECK" == "true" && \
                 "$BUILD_DEBUG_CHECK" == "true" && \
-                "$BUILD_WASM_CHECK" == "true" ]]; then
+                "$BUILD_WASM_CHECK" == "true" && \
+                "$DOCS_CHECK" == "true" ]]; then
+            echo "✅ All required checks passed!"
             echo "can-merge=true" >> $GITHUB_OUTPUT
           else
             echo "can-merge=false" >> $GITHUB_OUTPUT
@@ -175,20 +177,39 @@ jobs:
         with:
           script: |
             const canMerge = '${{ steps.check-results.outputs.can-merge }}' === 'true';
-            const comment = [
-              '## PR Validation Results',
-              '',
-              canMerge ? 'All required checks passed.' : 'Some required checks failed.',
-              '',
-              `- Code Formatting: ${{ steps.fmt-check.outputs.fmt_check == 'true' ? 'passed' : 'failed' }}`,
-              `- Clippy Lints: ${{ steps.clippy-check.outputs.clippy_check == 'true' ? 'passed' : 'failed' }}`,
-              `- Unit Tests: ${{ steps.test-check.outputs.test_check == 'true' ? 'passed' : 'failed' }}`,
-              `- Debug Build: ${{ steps.build-debug-check.outputs.build_debug_check == 'true' ? 'passed' : 'failed' }}`,
-              `- WASM Release Build: ${{ steps.build-wasm-check.outputs.build_wasm_check == 'true' ? 'passed' : 'failed' }}`,
-              `- Documentation: ${{ steps.docs-check.outputs.docs_check == 'true' ? 'passed' : 'failed' }}`,
-              `- Security Audit: ${{ steps.security-check.outputs.security_check == 'true' ? 'passed' : 'issues found' }}`,
-              `- Duplicate Dependencies: ${{ steps.duplicate-check.outputs.duplicate_check == 'true' ? 'passed' : 'issues found' }}`
-            ].join('\n');
+
+            const comment = `
+            ## 🤖 PR Validation Results
+
+            ${canMerge ? '✅ **This PR is ready to merge!**' : '❌ **This PR is not ready to merge yet.**'}
+
+            ### 📋 Required Checks:
+            - **Code Formatting**: ${{ steps.fmt-check.outputs.fmt_check == 'true' && '✅ Passed' || '❌ Failed' }}
+            - **Clippy Lints**: ${{ steps.clippy-check.outputs.clippy_check == 'true' && '✅ Passed' || '❌ Failed' }}
+            - **Unit Tests**: ${{ steps.test-check.outputs.test_check == 'true' && '✅ Passed' || '❌ Failed' }}
+            - **Debug Build**: ${{ steps.build-debug-check.outputs.build_debug_check == 'true' && '✅ Passed' || '❌ Failed' }}
+            - **WASM Release Build**: ${{ steps.build-wasm-check.outputs.build_wasm_check == 'true' && '✅ Passed' || '❌ Failed' }}
+            - **Documentation**: ${{ steps.docs-check.outputs.docs_check == 'true' && '✅ Passed' || '❌ Failed' }}
+
+            ### 📚 Optional Checks:
+            - **Security Audit**: ${{ steps.security-check.outputs.security_check == 'true' && '✅ Passed' || '⚠️ Issues Found' }}
+            - **Duplicate Dependencies**: ${{ steps.duplicate-check.outputs.duplicate_check == 'true' && '✅ Passed' || '⚠️ Issues Found' }}
+
+            ${!canMerge ? `
+            ### 🔧 How to Fix:
+            1. **Code Formatting**: Run \`cargo fmt --all\`
+            2. **Clippy Lints**: Fix all clippy warnings
+            3. **Unit Tests**: Make sure all tests pass with \`cargo test --lib\`
+            4. **Build**: Fix any compilation errors with \`cargo build\` and \`cargo build --target wasm32-unknown-unknown --release\`
+            5. **Documentation**: Fix any doc errors with \`cargo doc --no-deps\`
+
+            Please fix the failing checks and push your changes. The validation will run automatically.
+            ` : ''}
+
+            ---
+
+            🤖 *This comment was automatically generated by the PR validation workflow.*
+            `;
 
             await github.rest.issues.createComment({
               issue_number: context.issue.number,
@@ -197,12 +218,14 @@ jobs:
               body: comment
             });
 
+      # 11. Set PR status
       - name: Update PR status
         if: always()
         uses: actions/github-script@v7
         with:
           script: |
             const canMerge = '${{ steps.check-results.outputs.can-merge }}' === 'true';
+
             await github.rest.repos.createCommitStatus({
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -213,8 +236,10 @@ jobs:
               context: 'pr-validation'
             });
 
+      # 12. Branch protection enforcement
       - name: Enforce branch protection
         if: steps.check-results.outputs.can-merge == 'false'
         run: |
-          echo "PR cannot be merged due to failed checks"
+          echo "🚫 PR cannot be merged due to failed checks"
+          echo "Please fix all failing checks before this PR can be merged"
           exit 1

Cargo.toml

@@ -3,6 +3,7 @@ resolver = "2"
 members = [
   "contracts/community",
   "contracts/teachlink",
+  "contracts/insurance",
   "contracts/documentation",
 ]