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.

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

piqidoc #27

Open
edmcman opened this issue Mar 27, 2013 · 2 comments
Open

piqidoc #27

edmcman opened this issue Mar 27, 2013 · 2 comments
Labels

Comments

@edmcman
Copy link

edmcman commented Mar 27, 2013

It would be great to have a piqidoc tool that generates some pretty HTML pages documenting a type.

As I see it, piqi is a way to publicly specify and document a type. Values of that type can be converted to many formats, and "parsed" by JSON/XML in almost any language. Being able to generate a pretty representation of the types and documentation for humans seems like the final step.

@alavrik
Copy link
Owner

alavrik commented Mar 28, 2013

Yes, this is already on the project roadmap. What would be even cooler is the ability to generate cross-linked HTML pages and publish them online.

@motiejus
Copy link
Contributor

You could take into account that XSD generation would be very useful to have as well (sometime in far future I guess). It is a separate task, but looks on the same page. :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants