Guide links to non-existent config::Shutdown #6

rkt Version

1.0.0

Operating System

No response

Rust Toolchain Version

1.96.0

What happened?

Summary

The fairings guide links "shutdown is triggered" to
https://docs.rs/rkt/latest/rkt/config/struct.Shutdown.html#triggers, which
returns 404. The Shutdown type is no longer in the config module, and
the shutdown configuration has been split into separate types.

Location

• website/docs/08-fairings.md:117 — prose: "A shutdown callback is called when
  [shutdown is triggered]."
• website/docs/08-fairings.md:124 — link definition:
  [shutdown is triggered]: https://docs.rs/rkt/latest/rkt/config/struct.Shutdown.html#triggers

Findings

In the current rkt source the shutdown types live in the shutdown module:

core/lib/src/shutdown/mod.rs:11:  pub use config::ShutdownConfig;   // configuration
core/lib/src/shutdown/mod.rs:12:  pub use handle::Shutdown;         // runtime handle (re-exported at crate root)

Both of the following resolve 200 on docs.rs:

• https://docs.rs/rkt/latest/rkt/shutdown/struct.ShutdownConfig.html
• https://docs.rs/rkt/latest/rkt/struct.Shutdown.html

Suggested resolution

The original #triggers anchor documented what triggers a shutdown, which now
belongs to the configuration type. Repoint the link to
https://docs.rs/rkt/latest/rkt/shutdown/struct.ShutdownConfig.html and verify
the #triggers heading/anchor still exists there (otherwise drop the fragment).
Confirm whether the surrounding prose intends the config type
(ShutdownConfig) or the runtime handle (Shutdown) before finalizing.

Log Output