Improve docs IA, API reference depth, and PR docs preview workflow - #4
Merged
Merged
Conversation
Copilot created this pull request from a session on behalf of
achapkowski
July 16, 2026 13:06
View session
achapkowski
marked this pull request as ready for review
July 19, 2026 20:05
achapkowski
approved these changes
Jul 19, 2026
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
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.
The docs were functional but shallow: key
HttpNegotiateAuthbehaviors were undocumented, the Sphinx site was a single page, and contributors had no PR-visible rendered docs preview. This updates the user and developer documentation around the actual auth flow and adds a docs workflow that builds on PRs and uploads the rendered HTML artifact.README overhaul
httpx2API documentation
HttpNegotiateAuthdocumentation to cover:Authorizationheader short-circuitSphinx restructuring
index.rstto act as a landing page with a realtoctreeviewcodeand explicit version metadataContributor and workflow improvements
maindocs-htmlartifact so reviewers can inspect doc changes without building locallyExample of the expanded usage guidance: