Skip to content

CI never runs cargo doc to catch broken intra-doc links or doc-comment issues #173

Description

@chonilius

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is neededvery hardVery difficult task, expert-level effort required

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions