Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate markdown documentation based on schema/protocol #15

Open
jangalinski opened this issue Feb 13, 2024 · 0 comments
Open

Generate markdown documentation based on schema/protocol #15

jangalinski opened this issue Feb 13, 2024 · 0 comments
Labels
Idea 💡 An idea we could follow up

Comments

@jangalinski
Copy link
Contributor

Scenario

We have parsed avsc or avpr files and built a language model - we can use this to generate readable documentation.

Wanted Behaviour

  • generate markdown "code" containing types and docs of schema definitions and protocols
  • (optional): use template to influence how the markdown looks
@jangalinski jangalinski added the Type: enhancement New feature or request label Feb 13, 2024
@jangalinski jangalinski added the Idea 💡 An idea we could follow up label Aug 23, 2024
@jangalinski jangalinski removed the Type: enhancement New feature or request label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Idea 💡 An idea we could follow up
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jangalinski