rust-lang / docs.rs

crates.io documentation generator
https://docs.rs
MIT License
956 stars 193 forks source link

Surface warnings to users #2434

Open Nemo157 opened 4 months ago

Nemo157 commented 4 months ago

Currently when there is an issue like a build failure crate authors need to wait till the build has been run then visit the docs page to see whether it was successful or not. Commonly instead they first discover the issue when one of their users tries to visit the docs and sees the failure and notifies them (or us directly). It would be nice if we could more proactively surface these build failures (and potentially other warnings) to the authors.

One constraint I want to keep the design under is that we do not store any server-side data to try and do something like a push notification to the users; potentially in the future there could be some opt-in integration with crates.io if they get some kind of push notification system.

Proposed design:

syphar commented 4 months ago

I like the idea, though the impl probably depends on #1011 too, right?

Nemo157 commented 4 months ago

For adding more warnings like some targets failed, yes, for the UI part and just an initial "the last build failed" warning no, that should be possible now.

syphar commented 3 months ago

coming from a discussion on IRLO:

Owners might want to have email notifications for build failures, perhaps implemented via crates.io?