This codebase invests heavily in detailed /// doc comments — many with cross-references to specific issue numbers (#56, MergeFi/contracts#56) and to other functions/files. .github/workflows/ci.yml never runs cargo doc (with or without --document-private-items), so a malformed intra-doc link, a broken rustdoc code-block, or invalid markdown inside a doc comment would never be caught automatically — only ever discovered by chance if someone happens to open the rendered docs locally. A cargo doc --workspace --no-deps CI step (optionally with -D warnings on rustdoc::broken_intra_doc_links) would catch this class of issue for free, given how load-bearing these doc comments already are for understanding the codebase's non-obvious design decisions.
This codebase invests heavily in detailed
///doc comments — many with cross-references to specific issue numbers (#56,MergeFi/contracts#56) and to other functions/files..github/workflows/ci.ymlnever runscargo doc(with or without--document-private-items), so a malformed intra-doc link, a broken rustdoc code-block, or invalid markdown inside a doc comment would never be caught automatically — only ever discovered by chance if someone happens to open the rendered docs locally. Acargo doc --workspace --no-depsCI step (optionally with-D warningsonrustdoc::broken_intra_doc_links) would catch this class of issue for free, given how load-bearing these doc comments already are for understanding the codebase's non-obvious design decisions.