GitHub user hubcio added a comment to the discussion: Documentation for iggy (SDK) and iggy-bench
Hi @haubur, great initiative! We avoided extensive docs earlier because the API not-so-stable and maintaining it was a burden that slowed us down. Now that API is still unstable but LLMs are getting better and better, I think they are good enough to keep docs aligned with code (and have acceptable quality!). My general thoughts: - Crate docs should be the source of truth for API usage, examples, and code-level concepts. doctested examples are great (I did that in `IggyMessage`) - Website for high-level architecture, comparisons, anything related that doesn't belong in rustdoc. - Keep explanations concise in rustdoc - link to website for deep dives. - Your draft looksgood. The low-level/high-level API distinction is exactly what users need. Looking forward to seeing this evolve. See what needs to be documented in `prelude.rs` to have a good overview of whole Iggy Rust API. GitHub link: https://github.com/apache/iggy/discussions/2561#discussioncomment-15515718 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
