OAI / OAI/Arazzo-Specification
Add folders to examples to help organize examples
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 471
- Forks
- 69
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 19
Description
Was just looking at examples and I believe having examples in separate folders to organize the examples and/or use cases will make it easier to find more specific examples than scrolling through the growing list of examples we will hopefully have.
A folder like Authentication-Examples (or just Authentication) might work to separate oauth/token/etc examples.
One for Travel (and then folders below that if need be to organize travel examples).
Thoughts?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's current examples directory and its existing naming and grouping conventions. Define a concrete folder structure for the example use cases, then confirm that all examples remain easy to find and that any related references still point to their new locations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100