add known problems section restructure readme

README.md

@@ -1,31 +1,30 @@
 # Notify
 
 [![» Crate](https://flat.badgen.net/crates/v/notify)][crate]
-[![» Docs](https://flat.badgen.net/badge/api/docs.rs/df3600)][docs]
+[![» Docs](https://flat.badgen.net/badge/api/docs.rs/df3600)][notify-docs]
 [![» CI](https://flat.badgen.net/github/checks/notify-rs/notify/main)][build]
 [![» Downloads](https://flat.badgen.net/crates/d/notify)][crate]
 [![» Conduct](https://flat.badgen.net/badge/contributor/covenant/5e0d73)][coc]
 [![» Public Domain](https://flat.badgen.net/badge/license/CC0-1.0/purple)][cc0]
 
 _Cross-platform filesystem notification library for Rust._
 
-(Looking for desktop notifications instead? Have a look at [notify-rust] or
-[alert-after]!)
 
-- [API Documentation][docs]
-- [Mini Debouncer Documentation][debouncer-mini]
-- [Full Debouncer Documentation][debouncer-full]
+- [Notify Documentation][notify-docs]
+- [Mini Debouncer Documentation][debouncer-mini-docs]
+- [Full Debouncer Documentation][debouncer-full-docs]
 - [Examples][examples]
-- [Crate page][crate]
 - [Changelog][changelog]
-- [Upgrading from v4](UPGRADING_V4_TO_V5.md)
+- [Upgrading notify from v4](UPGRADING_V4_TO_V5.md)
 - Earliest supported Rust version: **1.60**
-- **incomplete [Guides and in-depth docs][wiki]**
 
 As used by: [alacritty], [cargo watch], [cobalt], [docket], [mdBook], [pax],
 [rdiff], [rust-analyzer], [timetrack], [watchexec], [xi-editor], [watchfiles],
 and others.
 
+(Looking for desktop notifications instead? Have a look at [notify-rust] or
+[alert-after]!)
+
 ## Platforms
 
 - Linux / Android: inotify
@@ -34,13 +33,6 @@ and others.
 - FreeBSD / NetBSD / OpenBSD / DragonflyBSD: kqueue
 - All platforms: polling
 
-### FSEvents
-
-Due to the inner security model of FSEvents (see [FileSystemEventSecurity]),
-some events cannot be observed easily when trying to follow files that do not
-belong to you. In this case, reverting to the pollwatcher can fix the issue,
-with a slight performance cost.
-
 ## License
 
 Notify was undergoing a transition to using the
@@ -63,8 +55,8 @@ Originally created by [Félix Saparelli] and awesome [contributors].
 
 [Chokidar]: https://github.com/paulmillr/chokidar
 [FileSystemEventSecurity]: https://developer.apple.com/library/mac/documentation/Darwin/Conceptual/FSEvents_ProgGuide/FileSystemEventSecurity/FileSystemEventSecurity.html
-[debouncer-full]: https://github.com/notify-rs/notify/tree/main/notify-debouncer-full
-[debouncer-mini]: https://github.com/notify-rs/notify/tree/main/notify-debouncer-mini
+[debouncer-full-docs]: https://docs.rs/notify-debouncer-full/latest/notify_debouncer_full/
+[debouncer-mini-docs]: https://docs.rs/notify-debouncer-mini/latest/notify_debouncer_mini/
 [Félix Saparelli]: https://passcod.name
 [alacritty]: https://github.com/jwilm/alacritty
 [alert-after]: https://github.com/frewsxcv/alert-after
@@ -78,7 +70,7 @@ Originally created by [Félix Saparelli] and awesome [contributors].
 [contributors]: https://github.com/notify-rs/notify/graphs/contributors
 [crate]: https://crates.io/crates/notify
 [docket]: https://iwillspeak.github.io/docket/
-[docs]: https://docs.rs/notify/6.0.1/notify/
+[notify-docs]: https://docs.rs/notify/latest/notify/
 [fsnotify]: https://github.com/go-fsnotify/fsnotify
 [handlebars-iron]: https://github.com/sunng87/handlebars-iron
 [hotwatch]: https://github.com/francesca64/hotwatch

notify-debouncer-full/src/lib.rs

@@ -57,6 +57,10 @@
 //! - `crossbeam` enabled by default, adds [`DebounceEventHandler`](DebounceEventHandler) support for crossbeam channels.
 //!   Also enables crossbeam-channel in the re-exported notify. You may want to disable this when using the tokio async runtime.
 //! - `serde` enables serde support for events.
+//! 
+//! # Caveats
+//! 
+//! As all file events are sourced from notify, the [known problems](https://docs.rs/notify/latest/notify/#known-problems) section applies here too.
 
 mod cache;
 mod debounced_event;

notify-debouncer-mini/src/lib.rs

@@ -48,6 +48,10 @@
 //! - `crossbeam` enabled by default, adds [`DebounceEventHandler`](DebounceEventHandler) support for crossbeam channels.
 //!   Also enables crossbeam-channel in the re-exported notify. You may want to disable this when using the tokio async runtime.
 //! - `serde` enables serde support for events.
+//! 
+//! # Caveats
+//! 
+//! As all file events are sourced from notify, the [known problems](https://docs.rs/notify/latest/notify/#known-problems) section applies here too.
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 use std::{

notify/src/lib.rs

@@ -7,8 +7,8 @@
 //! notify = "6.0.1"
 //! ```
 //!
-//! If you want debounced events, see [notify-debouncer-mini](https://github.com/notify-rs/notify/tree/main/notify-debouncer-mini)
-//! or [notify-debouncer-full](https://github.com/notify-rs/notify/tree/main/notify-debouncer-full).
+//! If you want debounced events (or don't need them in-order), see [notify-debouncer-mini](https://docs.rs/notify-debouncer-mini/latest/notify_debouncer_mini/)
+//! or [notify-debouncer-full](https://docs.rs/notify-debouncer-full/latest/notify_debouncer_full/).
 //!
 //! ## Features
 //!