docs: improve secrets and OAuth discoverability - #3206
Draft
topher-lo wants to merge 1 commit into
Draft
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
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
Validation
mint broken-linksuv run ruff check .git diff --checkscripts/generate_core_action_docs.py, excluding the known pre-existingcontentinput driftmint dev --port 3001preview of provider-ID examples, OAuth callout, links, and initially expanded Integrations navigationKnown existing issue
uv run python scripts/generate_core_action_docs.py --checkremains 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.