📝 Refine API doc notes and guidance

This commit is contained in:
Nanaloveyuki
2026-05-12 13:32:15 +08:00
parent 4d913aa642
commit c6c153cf53
47 changed files with 0 additions and 236 deletions
-5
View File
@@ -88,12 +88,7 @@ e.g.:
### Notes
Notes are here.
1. This type is sink-shape configuration, not the runtime sink itself.
2. Use `sink_config_to_json(...)` and `stringify_sink_config(...)` for export.
3. Prefer `SinkConfig::new(...)` over raw JSON when config is assembled programmatically.
4. `LoggerConfig` embeds exactly one `SinkConfig` plus an optional outer queue config.