Catch documentation errors caused by code changes

.github/workflows/ci.yml

@@ -49,3 +49,26 @@ jobs:
         with:
           command: test
           args: --verbose --release
+
+  doc-links:
+    name: Nightly lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          override: true
+      - name: cargo fetch
+        uses: actions-rs/cargo@v1
+        with:
+          command: fetch
+
+      # Ensure intra-documentation links all resolve correctly
+      # Requires #![deny(intra_doc_link_resolution_failure)] in crate.
+      - name: Check intra-doc links
+        uses: actions-rs/cargo@v1
+        with:
+          command: doc
+          args: --document-private-items

src/lib.rs

@@ -9,6 +9,8 @@
 //! * All operations are constant time unless explicitly noted.
 
 #![no_std]
+// Catch documentation errors caused by code changes.
+#![deny(intra_doc_link_resolution_failure)]
 #![deny(missing_debug_implementations)]
 #![deny(missing_docs)]
 #![deny(unsafe_code)]
@@ -39,6 +41,7 @@ mod util;
 /// and implemented by this library.
 pub mod notes {
     pub mod design;
+    pub mod serialization;
 }
 
 mod scalar;

src/notes/serialization.rs

@@ -0,0 +1,3 @@
+//! # BLS12-381 serialization
+//!
+//! TODO