Best practice for linking to the MCU definitions in atmega-hal from external Rustdoc

[p14c31355]

Hi,

I am currently writing a macro in my diagnostic workflow tool project (https://github.com/p14c31355/dvcdbg) that conforms any serial type to the core::fmt::Write trait.

In order to support arduino-hal, I’d like to provide users with a reference to the list of supported MCUs. Would it be okay to link directly to
avr-hal/mcu/atmega-hal/src/lib.rs
in my project’s Rustdoc?

Or do you think it would be better if such a list were maintained in a more official place (e.g. a SUPPORTED_MCUS.md or in the README)?

Thanks in advance!

[Rahix]

In avr-device, we tried maintaining a document with supported MCUs, but this got super messy over time so we now just link to the code for a complete list.

So doing the same in your case seems like the most sensible choice as well!