Yordis Prieto (Sep 15 2023 at 19:47): Yordis Prieto (Sep 15 2023 at 19:47):Hey folks, I noticed you can comment on the WIT files, but I haven't found documentation around Documenting the WIT files (my apologies if I missed it in advance).
I want my WIT files to contain the component's documentation, so correlating documentation to types, functions, enum values, import usage, export ... and whatnot is crucial from what I have in mind.
I come from the Elixir ecosystem where Docs are as important as code, so having something similar to https://hexdocs.pm/ would be highly extraordinary. Eliminating the need for external tools such as https://www.eventcatalog.dev/ to some extent (ideally, I could add metadata in a simple matter, so extensibility from the get-go would be incredible)
Any thoughts about the topic?
Lann Martin (Sep 15 2023 at 19:54):That would be great, and definitely a long-term goal for WIT. Currently doc comments are parsed into their associated AST items by wit-parser and preserved in the wit-component binary and text encodings. Beyond that I'm not aware of anyone working on rendering docs like docs.rs or your examples.
Yordis Prieto (Sep 15 2023 at 21:50):Is there any website like https://astexplorer.net/ to visualize the AST?
Last updated: Dec 23 2024 at 13:07 UTC