[demo] Autogenerate documentation on JSON sent to templates/jq from weaver_forge #736
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This creates a new utility, only intended to be used by weaver contributors, for generating documentation directly from SerDe / schemars configuration. These libraries leverage macros to read our own comments and produce a traversable schema.
UNFORTUNATELY, the schema is optimised for generating JSON schema, so it's actually poor for generating docs. This is ~2 hour attempt at doing something decent enough to evaluate if we want to invest in it. Alternatively, we could use schemars to generate docs and then fire these at an NPM utility that creates markdown from json schema.
Either way the goal of this PR is to:
cargo run -p docgen
)Towards: #692 and #693