Skip to content

docs: make the local/Jupyter path visible from the quick start - #9549

Open
atlaie wants to merge 1 commit into
OpenMined:devfrom
atlaie:docs/local-quickstart-notice
Open

atlaie wants to merge 1 commit into
OpenMined:devfrom
atlaie:docs/local-quickstart-notice

Conversation

@atlaie

@atlaie atlaie commented Oct 2, 2026

Copy link
Copy Markdown

The README quick start now opens with a note that it assumes Google Colab, and its login comments show the local form with token_path, pointing local and Jupyter users to docs/auth.md (about 15 minutes the first time, one Google account per role). Previously the quick start failed on the first login call for anyone not on Colab, and nothing pointed to the setup docs. This closes UX audit findings H-003, H-006, H-008 and AI-003 to AI-006, and the wording follows the 29 Sep agreement. Beyond the notice, docs/auth.md now has a token example that runs top to bottom, a new "Running two roles on one machine" section, and fixes for several typos and a broken bold marker. Koen, rather than a prose review, could you confirm two facts: that credentials_to_token writes token.json next to the credentials file by default, and that a second account must be listed as a test user while the app is unpublished?

…auth.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant