Stream: general

Topic: docs for wit files?

view this post on Zulip mogambro (Aug 27 2025 at 21:03):

Hello!
Is there some tooling I missed to generate a cargo docs like page for wit files?

I'd like to document some interfaces and wonder how I'll do that for clients/implementers.

Any hints appreciated!

view this post on Zulip Dan Gohman (Aug 27 2025 at 21:08):

Something that works pretty well is to use wit-bindgen to generate bindings for specific languages, and then run those languages' documentation generators (eg. cargo doc) on the generated bindings.

view this post on Zulip Lann Martin (Aug 27 2025 at 21:11):

There is also the wit-bindgen markdown command, which produces output like this: https://github.com/WebAssembly/wasi-clocks/blob/main/imports.md

wasi-clocks/imports.md at main · WebAssembly/wasi-clocks
Clocks API for WASI. Contribute to WebAssembly/wasi-clocks development by creating an account on GitHub.

view this post on Zulip Lann Martin (Aug 27 2025 at 21:11):

(though I also personally prefer the generated rustdocs)

Last updated: Dec 06 2025 at 05:03 UTC