A2A JSON schema generated documentation #287
pvlasov
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hello,
I've created a documentation generator for JSON schemas and generated a documentation site for the A2A JSON schema. It features generated diagrams, full text search, and more as explained in Documenting JSON schemas story.
I use the documentation to get a grasp JSON structures in a non-linear way - by looking and diagrams and clicking on diagram elements instead of scrolling text. I hope this documentation will help the A2A community as it helps me!
Currently it contains only the information what was available in the schema itself - everything was generated - I added one documentation sentence and manually rearranged elements on the home page diagram, which also was generated. However, documentation pages can be extended with hand-crafted documentation - descriptions, code snippets, ...
Beta Was this translation helpful? Give feedback.
All reactions