ci: improve doc checking

CONTRIBUTING.md

@@ -13,6 +13,10 @@ If you're unsure, let's figure it out together!
 
 ## Project management
 
+We use the [just](https://github.com/casey/just) command runner for Continuous Integration (CI).
+The GitHub Actions infrastructure merely calls `just` to execute jobs.
+This means that you can run all required tests for a PR using `just ci`.
+
 ### Code formatting
 
 Code is formatted using [`rustfmt`] with a custom `rustfmt.toml` and checked in CI.

imap-codec/src/extensions/binary.rs

@@ -22,7 +22,7 @@ use crate::{
     fetch::section_part,
 };
 
-/// See https://datatracker.ietf.org/doc/html/rfc3516 and https://datatracker.ietf.org/doc/html/rfc4466
+/// See <https://datatracker.ietf.org/doc/html/rfc3516> and <https://datatracker.ietf.org/doc/html/rfc4466>
 ///
 /// ```abnf
 /// literal8 = "~{" number ["+"] "}" CRLF *OCTET

imap-codec/src/extensions/id.rs

@@ -45,7 +45,7 @@ pub(crate) fn id_response(input: &[u8]) -> IMAPResult<&[u8], Option<Vec<(IString
 /// id-params-list = "(" [string SP nstring *(SP string SP nstring)] ")" / nil
 /// ```
 ///
-/// Note: Updated ABNF. (See https://github.com/modern-email/defects/issues/12)
+/// Note: Updated ABNF. (See <https://github.com/modern-email/defects/issues/12>)
 #[allow(clippy::type_complexity)]
 pub(crate) fn id_params_list(input: &[u8]) -> IMAPResult<&[u8], Option<Vec<(IString, NString)>>> {
     alt((

imap-codec/src/extensions/idle.rs

@@ -1,6 +1,6 @@
 //! IMAP4 IDLE command
 //!
-//! This extension enables the [`CommandBody::Idle`](crate::command::CommandBody#variant.Idle) variant.
+//! This extension enables the [`CommandBody::Idle`](imap_types::command::CommandBody#variant.Idle) variant.
 //! No additional types are used.
 
 // Additional changes:

justfile

@@ -35,6 +35,7 @@ check_impl mode features: (cargo_check mode features) \
 [private]
 cargo_check mode features:
     cargo check --workspace --all-targets{{ mode }}{{ features }}
+    cargo doc --no-deps --document-private-items --keep-going{{ mode }}{{ features }}
 
 [private]
 cargo_hack mode: install_cargo_hack