Skip to content

docs: improve secrets and OAuth discoverability - #3206

Draft
topher-lo wants to merge 1 commit into
mainfrom
codex/docs-secrets-oauth-discoverability
Draft

docs: improve secrets and OAuth discoverability#3206
topher-lo wants to merge 1 commit into
mainfrom
codex/docs-secrets-oauth-discoverability

Conversation

@topher-lo

@topher-lo topher-lo commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Expand the Automations sidebar's Integrations group by default.
  • Add static secret and managed OAuth authentication patterns to the HTTP request action docs.
  • Document provider ID naming for built-in and custom OAuth providers, including token-key derivation.
  • Explain OAuth token refresh or reacquisition and access-token resolution.

Why

Secrets and OAuth guidance was difficult to discover because Integrations was collapsed by default and the HTTP request docs did not show common REST API authentication patterns. The generic OAuth placeholders also did not explain how built-in and custom provider IDs map to secret paths.

Impact

Documentation only. This does not change runtime behavior, APIs, action schemas, or unrelated generated actions.

Root cause

The navigation configuration did not expand Integrations, and the generated HTTP page had no hand-authored authentication guidance in its manifest source.

LOC breakdown

Category + -
Docs 157 0

Validation

  • mint broken-links
  • uv run ruff check .
  • git diff --check
  • Targeted HTTP page render comparison against scripts/generate_core_action_docs.py, excluding the known pre-existing content input drift
  • mint dev --port 3001 preview of provider-ID examples, OAuth callout, links, and initially expanded Integrations navigation
  • Pre-commit hooks

Known existing issue

  • uv run python scripts/generate_core_action_docs.py --check remains blocked by unrelated undocumented core actions already present in the repository; this PR intentionally does not regenerate or document them.

Summary by cubic

Improves discoverability of Secrets and OAuth docs by expanding the Automations → Integrations sidebar by default and adding REST API auth patterns to the HTTP request action. Documents provider ID rules for built-in and custom OAuth providers, token-key naming, and how Tracecat refreshes or reacquires access tokens.

Written for commit 195aa9b. Summary will update on new commits.

Review in cubic

@mintlify

mintlify Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tracecat 🟢 Ready View Preview Aug 6, 2026, 1:15 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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