Documentation Section

I propose that a custom section be defined that supplied documentation of the exported api at various levels of specificity. For example, there could be module-level documentation, function-level, parameter-level, type-level, etc.

I think it should directly interface with the interface types proposal (when available, the section can be usable before then) to have the ability to document, for example, individual fields of record parameters, or individual variants of variant parameters.

The goal is to enable support for IntelliSense-like support when programming against a wasm module's api.

I'll make a pr with some initial thoughts on this in a week or so if people think this is a good idea.

I originally made an issue on the interface-types repo (https://github.com/WebAssembly/interface-types/issues/110), but it was suggested that the issue be raised here instead since it would be a tool-convention not a standardized feature.

Start by reading issue 141 and the referenced interface-types issue 110 to understand the proposed documentation levels and their relationship to interface types. Since no implementation files or tests are named, first determine where tool conventions are specified and how a custom section would be documented. Done would mean an agreed convention with its scope and interface documented, likely through the proposed pull request.