Add documentation #30
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Mention software channels for openapi generator (npm, docker, jar) - Simplify introduction language. - Show schema example. Path and Object.
Codecov Report
@@ Coverage Diff @@
## main #30 +/- ##
=======================================
Coverage 78.52% 78.52%
=======================================
Files 7 7
Lines 489 489
=======================================
Hits 384 384
Misses 105 105 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
- Add PetStore link
|
I'm gonna say that this is ready for review. This package is important and popular enough to warrant a proper documentation solution so we should shift to that next. Documentation is subjective at some level but I think the introduction I've written is more beginner friendly. Let me know your thoughts. |
|
Closing as outdated |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We should consider Documenter for a more scalable documentation solution. And perhaps we could add a PetStore.jl package as an example. Maybe even a github workflow to file a PR directly a openapi schema diff ?
Also, let me know if you have any other ideas.