Add high-level documentation for 3.0 #1646
Merged
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
RobbeSneyders
force-pushed
the
feature/v3-docs
branch
from
6f372ad
to
b8d32da
Compare
Pull Request Test Coverage Report for Build 4318569385
💛 - Coveralls |
Ruwann
approved these changes
Feb 25, 2023
| Do not use Connexion 3.0 in production yet! | ||
|
|
||
| Connexion 3.0 is currently available in alpha to give users the ability to test it and provide | ||
| feedback while we further polish the codebase and update the documentation. |
There was a problem hiding this comment.
Small one: Let's make it explicit what the best way is for users to provide feedback?
--> by creation an separate issue
--> as comment on a general feedback 3.x issue
There was a problem hiding this comment.
I'll add this in the announcement on Github. We can then later refer to that announcement in this doc, but currently it's a bit chicken and egg :)
RobbeSneyders
force-pushed
the
feature/v3-docs
branch
from
b8d32da
to
cdff337
Compare
RobbeSneyders
force-pushed
the
feature/v3-docs
branch
from
cdff337
to
409fc7e
Compare
17 tasks
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.
I'd like to cut an alpha release for 3.0 while we further polish the code base and update the documentation. This way users can already test 3.0 and provide feedback.
This PR adds some very high-level documentation to serve as a starting point for users to test the alpha version.