Skip to content

docs: add OIDC auth pointers to primary notebooks [sc-17043] - #550

Merged
emmavdh merged 1 commit into
mainfrom
emma/sc-17043-library-oidc-docs-pointers
Jul 31, 2026
Merged

docs: add OIDC auth pointers to primary notebooks [sc-17043]#550
emmavdh merged 1 commit into
mainfrom
emma/sc-17043-library-oidc-docs-pointers

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

What and why?

Follow-up to documentation PR #1458 / sc-17043.

Adds a short OIDC alternative pointer (with prod docs URLs) to the primary API-key setup notebooks and install templates, and links the dedicated OIDC quickstart notebook to the new docs page:

https://docs.validmind.ai/developer/quickstart/authenticate-with-oidc-device-flow.html

Notebooks updated

  • notebooks/quickstart/quickstart_documentation.ipynb
  • notebooks/quickstart/quickstart_validation.ipynb
  • notebooks/quickstart/quickstart_model_documentation_oidc_device_flow.ipynb
  • notebooks/tutorials/development/1-set_up_validmind.ipynb
  • notebooks/tutorials/validation/1-set_up_validmind_for_validation.ipynb
  • notebooks/templates/install-validmind/_install-initialize-with-development.ipynb
  • notebooks/templates/install-validmind/_install-initialize-with-validation.ipynb
  • notebooks/templates/install-validmind/_install-initialize-with-monitoring.ipynb

API-key flows remain the default. No use-case notebooks were bulk-converted.

How to test

  1. Open each updated notebook and confirm the OIDC pointer appears near the code-snippet / init guidance.
  2. Confirm links resolve (docs page will 404 on prod until documentation PR #1458 is released; staging preview: https://docs-staging.validmind.ai/pr_previews/emma/sc-17043-documentation-library-oidc/developer/quickstart/authenticate-with-oidc-device-flow.html).
  3. After merge, sync into documentation with make notebooks / make get-source when ready to publish notebook updates on the docs site.

What needs special review?

  • Docs URL depends on documentation PR #1458 shipping to prod.
  • Intentionally limited to high-traffic setup notebooks/templates; broader use-case notebooks left unchanged.

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@emmavdh emmavdh added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Jul 30, 2026
@CLAassistant

CLAassistant commented Jul 30, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@emmavdh emmavdh removed the documentation Improvements or additions to documentation label Jul 30, 2026
@emmavdh emmavdh self-assigned this Jul 31, 2026
Link API-key setup notebooks and templates to the OIDC device-flow docs page and dedicated quickstart, with minimal notebook diffs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh
emmavdh force-pushed the emma/sc-17043-library-oidc-docs-pointers branch from c690895 to 25621e5 Compare July 31, 2026 01:02
@emmavdh
emmavdh merged commit 21fffbb into main Jul 31, 2026
6 checks passed
@emmavdh
emmavdh deleted the emma/sc-17043-library-oidc-docs-pointers branch July 31, 2026 01:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants