ci: add intra-doc links lint

.github/workflows/lint.yml

@@ -47,9 +47,23 @@ jobs:
       - name: Clippy Check
         uses: giraffate/clippy-action@v1
         with:
+          clippy_flags: --workspace --all-targets --all-features
           reporter: github-pr-check
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          clippy_flags: --workspace --all-targets --all-features
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust
+        uses: actions-rust-lang/setup-rust-toolchain@v1.5.0
+        with:
+          components: rust-docs
+
+      - name: Validate Intraoc Links
+        env:
+          RUSTDOCFLAGS: -D warnings
+        run: cargo doc --workspace --no-deps --all-features
 
   audit:
     name: Audit
@@ -67,4 +81,4 @@ jobs:
           tool: cargo-deny
 
       - name: Audit check
-        run: cargo deny check advisories
+        run: cargo deny --all-features check advisories

examples/http-01.rs

@@ -116,6 +116,11 @@ async fn main() -> eyre::Result<()> {
 
     // Finally download the certificate.
     let cert = ord_cert.download_cert().await?;
+
+    // NOTE: Here you would spawn your HTTP server and use the private key plus
+    // certificate to configure TLS on it. For this example, we just print the
+    // certificate and exit.
+
     println!("{}", cert.certificate());
 
     // Stop temporary server for ACME challenge

src/order/mod.rs

@@ -196,7 +196,7 @@ impl NewOrder {
 /// * P-256 and P-384 ECDSA keys
 ///
 /// [CSR]: https://en.wikipedia.org/wiki/Certificate_signing_request
-/// [functions to create key pairs]: ../index.html#functions
+/// [functions to create private keys]: ../index.html#functions
 /// [supports]: https://letsencrypt.org/docs/integration-guide/#supported-key-algorithms
 pub struct CsrOrder {
     pub(crate) order: Order,