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

Documentation improvements: Tutorials and FAQs #82

Open
arno-di-loreto opened this issue May 8, 2016 · 1 comment
Open

Documentation improvements: Tutorials and FAQs #82

arno-di-loreto opened this issue May 8, 2016 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@arno-di-loreto
Copy link

It would be a great addition to the spec to have:

  • Tutorials from beginner to expert level (disclosure: I'm currently writing one)
  • FAQs to find a quick response to a specific use case without having to dig in the spec or do the tutorials ("how do I reuse a definition", "how do I set a response header", ...)
  • Standalone example YAML files (linked to tutorials, FAQs)
@arno-di-loreto arno-di-loreto changed the title Tutorials and FAQs (Specification documentation structure and supporting docs) Documentation improvements: Tutorials and FAQs May 8, 2016
@arno-di-loreto
Copy link
Author

parent OAI/OpenAPI-Specification#589

@webron webron added the documentation Improvements or additions to documentation label May 19, 2016
@handrews handrews transferred this issue from OAI/OpenAPI-Specification Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@webron @arno-di-loreto