Skip to content

Conversation

@proxymesh
Copy link
Owner

Summary

  • Add prominent "Getting Started" section at the top of each library doc with prerequisites and quick examples
  • Document standard library proxy usage (authentication, environment variables, sessions) before introducing extensions
  • Add comprehensive API Reference sections with function signatures
  • Improve overall structure to match official library documentation style

Changes by file

  • urllib3.rst: Added Getting Started, proxy auth, API reference for ProxyHeaderManager
  • requests.rst: Added Getting Started, env vars, session config, all HTTP method examples
  • aiohttp.rst: Added Getting Started, proxy_auth examples, session-level proxy config
  • httpx.rst: Added Getting Started, SOCKS proxy, mounts for different proxies, API reference

Test plan

  • Verify documentation builds without errors
  • Review rendered documentation for accuracy and completeness

- Add prominent "Getting Started" section at the top of each library doc
- Include prerequisites (installation) and quick example for each library
- Document standard library proxy usage before introducing extension
- Add proxy authentication examples
- Add environment variable and session-level proxy configuration
- Add API Reference sections with function signatures
- Improve overall structure to match official library documentation style
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants