You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
once we have comments in our schema, we can generate pretty decent documentation from a webrpc schema definition (in either ridl or json of course, since they're the same just different formats).
I've added https://github.com/webrpc/gen-markdown which we can use to parse a single schema file, and output a markdown contents, which can be piped into a file, or can be used in a pipeline for example with any static site docs generator (ie. docusaurus, vocs.dev, etc. etc.), and then it makes it easy to have a "API Reference" section in docs which are generated by this gen-markdown with comments coming from the schema.
The text was updated successfully, but these errors were encountered:
related to #246
once we have comments in our schema, we can generate pretty decent documentation from a webrpc schema definition (in either ridl or json of course, since they're the same just different formats).
I've added https://github.com/webrpc/gen-markdown which we can use to parse a single schema file, and output a markdown contents, which can be piped into a file, or can be used in a pipeline for example with any static site docs generator (ie. docusaurus, vocs.dev, etc. etc.), and then it makes it easy to have a "API Reference" section in docs which are generated by this gen-markdown with comments coming from the schema.
The text was updated successfully, but these errors were encountered: