Complete Rust API and migration documentation (#102)

tools/ci-matrix/src/main.rs

@@ -1,4 +1,7 @@
-use metacrate_ci_matrix::{audit, audit_dependencies, load, run, workspace_root};
+use metacrate_ci_matrix::{
+    audit, audit_dependencies, audit_documentation, load, run, workspace_root,
+    write_documentation_report,
+};
 use std::path::{Path, PathBuf};
 
 fn main() {
@@ -46,9 +49,27 @@ fn execute() -> Result<(), Box<dyn std::error::Error>> {
             audit_dependencies(&root, &evidence)?;
             println!("dependency policy: ok ({})", evidence.display());
         }
+        Some("documentation-report") if arguments.next().is_none() => {
+            write_documentation_report(&root)?;
+            println!("documentation coverage report: updated");
+        }
+        Some("documentation-audit") => {
+            let flag = arguments
+                .next()
+                .ok_or("documentation-audit requires --evidence FILE")?;
+            let evidence = arguments
+                .next()
+                .ok_or("documentation-audit requires --evidence FILE")?;
+            if flag != "--evidence" || arguments.next().is_some() {
+                return Err("usage: ci-matrix documentation-audit --evidence FILE".into());
+            }
+            let evidence = absolute_or_rooted(&root, &evidence);
+            audit_documentation(&root, &evidence)?;
+            println!("documentation coverage: ok ({})", evidence.display());
+        }
         _ => {
             return Err(
-                "usage: ci-matrix audit | run PROFILE --evidence FILE | dependency-audit --evidence FILE"
+                "usage: ci-matrix audit | run PROFILE --evidence FILE | dependency-audit --evidence FILE | documentation-report | documentation-audit --evidence FILE"
                     .into(),
             );
         }