Skip to content

Have a way that crates.io could tell if a crate has successfully built docs on docs.rs #87

Closed
@carols10cents

Description

@carols10cents

This is what's blocking rust-lang/crates.io#459.

I personally think that at least one major blocker for this will be to not generate a link for crates which have documentation that failed to build on docs.rs. That may unfortunately provide a pretty sub-par experience :(

Is there currently an automated, definitive way that crates.io could check to see if docs.rs has built docs successfully?

If there isn't currently a way to do this, I'm trying to imagine what the best way would be, for both sides.

Crates.io can't check on crate publish and store that data, since docs.rs can't build docs for crates it doesn't know are published yet 😂😂😂 So I guess it would be better to check when crates.io is rendering a crate show page... but we can't request a docs.rs URL with AJAX since that's cross-domain.

Is there a way to make the docs.rs badge not render if the docs haven't built?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions