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

Schema definitions should be linked or inlined in HTML docsform #27

Open
jonnor opened this issue Aug 18, 2015 · 1 comment
Open

Schema definitions should be linked or inlined in HTML docsform #27

jonnor opened this issue Aug 18, 2015 · 1 comment

Comments

@jonnor
Copy link
Contributor

jonnor commented Aug 18, 2015

Right now we just raw-dump the schemas into the blueprint. This is useful-ish, but things like $ref: someother-schema is confusing.

References should be resolved, and then put links into the HTML to navigate up/down between these. For single base definitions (which are usually very short) it might be nicer to inline.
Also, there should probably be a link to the schema itself (in .yml and .json format), so people see where it comes from.

Came up in #26

@automata
Copy link
Contributor

Using something like docson to generate an HTML with all schemas in one page could be useful to navigate too.

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

No branches or pull requests

2 participants