Skip to content

docs: fix documentation drift in README and examples - #144

Merged
rmad17 merged 6 commits into
mainfrom
docs/sync-2026-07-29
Jul 31, 2026
Merged

docs: fix documentation drift in README and examples#144
rmad17 merged 6 commits into
mainfrom
docs/sync-2026-07-29

Conversation

@rmad17

@rmad17 rmad17 commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

📋 Changes

This PR fixes documentation drift across README.md and the examples/ documentation for the current 1.0.0b13 API surface. A full audit found and addressed 9 issues: 6 P1 copy-paste/runtime failures and 3 P3 style
or consistency fixes.

Fixes

  • Corrected the installation command in README.md from poetry install auth0-server-python to poetry add auth0-server-python
  • Quoted the redirect_uri dictionary key in README.md so the Python snippet no longer raises NameError
  • Fixed ServerClient imports in examples/ClientInitiatedBackChannelLogin.md and examples/MultipleCustomDomains.md to use from auth0_server_python.auth_server import ServerClient
  • Fixed store imports in examples/ConfigureStore.md to use from auth0_server_python.store import ...
  • Added the missing comma between audience= and scope= in examples/RetrievingData.md
  • Updated SDK examples in examples/RetrievingData.md from JS-style naming to the actual Python API names: server_client, get_user, get_access_token, and login_hint
  • Hoisted inline import json statements out of method bodies in examples/ConfigureStore.md
  • Aligned examples with the package’s current import paths and Python naming conventions

Testing

  • This change adds documentation correction coverage through snippet verification
  • Every corrected import/snippet was validated against the current source tree

Contributor Checklist

@rmad17
rmad17 requested a review from a team as a code owner July 29, 2026 11:25
@rmad17 rmad17 changed the title docs: sync documentation with current API (automated) docs: fix documentation drift in README and examples Jul 31, 2026

@kishore7snehil kishore7snehil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@rmad17
rmad17 merged commit 3ef6d0e into main Jul 31, 2026
9 checks passed
@rmad17
rmad17 deleted the docs/sync-2026-07-29 branch July 31, 2026 09:50
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.

3 participants