docs: Improved clarity and formatting within documentation#2033
Open
feteu wants to merge 25 commits into
Open
Conversation
chrisinmtown
approved these changes
Mar 23, 2025
chrisinmtown
left a comment
chrisinmtown
left a comment
Contributor
There was a problem hiding this comment.
This PR cleans up many small documentation problems and I recommend merging it. I added a couple tiny comments. Please note I'm a fellow user, not a maintainer.
Author
|
@chrisinmtown thanks for taking the time to quickly go over the adjustments. I've fixed most of the suggestions. |
Author
|
@Ruwann is this ready to go or do you have any objections? |
chrisinmtown
approved these changes
Jul 12, 2025
feteu
changed the title
Contributor
|
I pulled in your changes because the project is getting farther behind, and now the sphinx build it breaking. So hopefully, the maintainers will take that one as well and my other PR to help with otel. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #2032.
Changes proposed in this pull request:
.rstand.mdfiles, including:index.rstlifespan.rstmiddleware.rstquickstart.rstrequest.rstresponse.rstsecurity.rstswagger_ui.rsttesting.rstv3.rstvalidation.rstREADME.mdThese updates enhance readability and maintain consistency across the documentation.