Skip to content

docs: add OAuth2 upstream auth page - #3042

Open
LeonSGP43 wants to merge 1 commit into
headroomlabs-ai:mainfrom
LeonSGP43:docs/oauth2-plugin-page
Open

docs: add OAuth2 upstream auth page#3042
LeonSGP43 wants to merge 1 commit into
headroomlabs-ai:mainfrom
LeonSGP43:docs/oauth2-plugin-page

Conversation

@LeonSGP43

@LeonSGP43 LeonSGP43 commented Aug 15, 2026

Copy link
Copy Markdown

Description

Adds docs/content/docs/oauth2-upstream.mdx and registers it in the Integrations nav. plugins/headroom-oauth2 ships with a README + SPEC, but the docs site has no page covering enterprise OAuth2 client-credentials upstream auth — enterprise-gateway users have no discoverable documentation for this path. Content is faithful to plugins/headroom-oauth2/README.md.

Type of Change

  • Documentation update

Changes Made

  • Added docs/content/docs/oauth2-upstream.mdx: install, enable, client-credentials config, upstream auth flow, and troubleshooting.
  • Registered the page in docs/content/docs/meta.json Integrations nav.

Testing

  • Unit tests pass (pytest)
  • Linting passes (ruff check .)
  • Type checking passes (mypy headroom)
  • New tests added for new functionality
  • Manual testing performed

Test Output

# Docs-only change: no Python surface touched, so pytest/ruff/mypy are unaffected.
# Manual checks performed:
#   - new page frontmatter/title matches sibling Integrations pages
#   - docs/content/docs/meta.json remains valid JSON with the new nav entry
#   - markdown links resolve to existing docs pages

Real Behavior Proof

  • Environment: local checkout of main + branch
  • Exact command / steps: inspected docs/content/docs/meta.json after edit (valid JSON, nav ordering correct); diffed the new page's frontmatter against sibling integration pages
  • Observed result: page follows the same MDX structure and renders in the expected Integrations section
  • Not tested: full fumadocs site build (requires Node install); content is plain MDX consistent with existing pages

Runtime Rollout Safety

  • Rollout-managed feature(s): none — documentation only
  • Minimum rollout channel: N/A
  • Stable/default behavior changed: none
  • Kill switch / disable path: N/A
  • Unsafe override required: none
  • Qualification impact: none
  • Rollback path: revert the commit(s) on this branch

Review Readiness

  • I have performed a self-review
  • This PR is ready for human review

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I did not edit CHANGELOG.md — it is generated by release-please from my Conventional Commit PR title

Additional Notes

Docs-only PR: pytest/ruff/mypy items intentionally unchecked (no Python code changed).

Add docs/content/docs/oauth2-upstream.mdx covering the
plugins/headroom-oauth2 proxy extension: install/enable commands,
the HEADROOM_OAUTH2_* env matrix, effective-backend caveats, and
TLS/transport notes — sourced from plugins/headroom-oauth2/README.md
and SPEC.md. Register the page in the Integrations nav.

Signed-off-by: LeonSGP43 <LeonSGP43@users.noreply.github.com>
@github-actions

github-actions Bot commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

PR governance

This PR follows the template and is marked ready for human review.

@github-actions github-actions Bot added status: needs author action Pull request body or readiness checklist still needs author updates status: ready for review Pull request body is complete and the author marked it ready for human review and removed status: needs author action Pull request body or readiness checklist still needs author updates labels Aug 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: ready for review Pull request body is complete and the author marked it ready for human review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant