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

Break up the spec into a set of documents #558

Closed
pmackay opened this issue Feb 10, 2016 · 5 comments
Closed

Break up the spec into a set of documents #558

pmackay opened this issue Feb 10, 2016 · 5 comments

Comments

@pmackay
Copy link

pmackay commented Feb 10, 2016

Such that it can be displayed on a site like https://readthedocs.org/ or built into a doc set with a generated index.

This is a more significant change than that proposed by #464, but its a long spec and hard to digest currently.

@webron
Copy link
Member

webron commented Mar 1, 2016

@fehguy - I've erased the link you created to the meta issue. This is not about splitting OpenAPI definition file into multiple ones, this is about splitting the specification document itself to sub-section documents.

@fehguy
Copy link
Contributor

fehguy commented Mar 1, 2016

Sure thing--can you tie it to the appropriate meta issue?

@webron
Copy link
Member

webron commented Mar 1, 2016

I'll create a meta documentation issue that isn't related to what the spec supports but rather how the spec is documented and the support documents we may want to provide.

@webron
Copy link
Member

webron commented Mar 1, 2016

Parent issue: #589

@webron
Copy link
Member

webron commented Mar 3, 2017

We've ended up deciding to not split the spec.

@webron webron closed this as completed Mar 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants