linebender / druid

A data-first Rust-native UI design toolkit.
https://linebender.org/druid/
Apache License 2.0
9.45k stars 569 forks source link

Fix documentation links. #2338

Closed xStrom closed 1 year ago

xStrom commented 1 year ago

I went over all the documentation and fixed every broken link I could find. It's not perfect, there are still broken links that are caused by code that is not in this repo (kurbo, piet, im) but obviously those will need to be fixed elsewhere.

The strategy here was to resolve broken links by changing the URL link to a rustdoc managed symbol based link. This method supports the link appearing at different levels of nesting (which URL links never did) and also has the benefit of sometimes being automatically detected when broken. Not every link was converted, but the remaining URL links still work.

Another thing to note is that when a symbol is in scope then the link doesn't have to be defined at all.

/// If the [`Widget`] trait is in scope, then that link will just work.