Skip to content

docs(ia): revamping approval workflows doc and moving it to Secrets Management#5878

Merged
jakehulberg merged 23 commits into
mainfrom
docs/agent-docs-testing-pr-workflows
Apr 7, 2026
Merged

docs(ia): revamping approval workflows doc and moving it to Secrets Management#5878
jakehulberg merged 23 commits into
mainfrom
docs/agent-docs-testing-pr-workflows

Conversation

@jakehulberg
Copy link
Copy Markdown
Contributor

Context

Revamped the approval workfow doc as it was very verbose. Changed it to a how-to guide and moved it to Secrets Management product reference.

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • [ X] Docs
  • Chore

Checklist

  • [ x] Title follows the conventional commit format: type(scope): short description (scope is optional, e.g., fix: prevent crash on sync or fix(api): handle null response).
  • [ x] Tested locally
  • [ x] Updated docs (if needed)
  • [ x] Updated CLAUDE.md files (if needed)
  • [ x] Read the contributing guide

@jakehulberg jakehulberg requested a review from dangtony98 March 31, 2026 13:45
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Mar 31, 2026

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

Project Status Preview Updated (UTC)
infisical 🟢 Ready View Preview Mar 31, 2026, 1:49 PM

@maidul98
Copy link
Copy Markdown
Collaborator

maidul98 commented Mar 31, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@jakehulberg jakehulberg changed the title Docs(approval workflows): Revamping approval workflows doc and moving it to Secrets Management Docs(approval workflows): revamping approval workflows doc and moving it to Secrets Management Mar 31, 2026
@jakehulberg jakehulberg changed the title Docs(approval workflows): revamping approval workflows doc and moving it to Secrets Management docs(approval workflows): revamping approval workflows doc and moving it to Secrets Management Mar 31, 2026
@jakehulberg jakehulberg changed the title docs(approval workflows): revamping approval workflows doc and moving it to Secrets Management docs(ia): revamping approval workflows doc and moving it to Secrets Management Mar 31, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 31, 2026

Greptile Summary

This PR revamps the Approval Workflows documentation from a verbose problem/solution description into a concise, structured how-to guide, and moves the page from the Access Controls navigation group into Secrets Management → Product Reference in docs.json. The content improvements are solid — clearer prerequisites, numbered steps, explicit action descriptions (Approve / Merge / Reject), and updated related-resource links including Microsoft Teams. Three minor style issues are worth a quick look before merging:

  • The contact email for self-hosted enterprise license purchases changed from sales@infisical.com to team@infisical.com, which is inconsistent with the majority of other docs in the repo that still point to sales@infisical.com for license purchases.
  • sidebarTitle is set to the same value as title, making it redundant.
  • Sub-headings inside the first <Step> use ####, skipping the ### level, which can affect the generated Mintlify TOC hierarchy.

Confidence Score: 5/5

Safe to merge; all findings are P2 style/content suggestions with no code logic, security, or build impact.

This is a pure documentation PR with no code changes. The three flagged items are all P2: a contact-email inconsistency that should be verified but doesn't break anything, a redundant frontmatter field, and a heading-level skip inside a Mintlify Step component. None of these block functionality or correctness.

docs/documentation/platform/pr-workflows.mdx — contact email and heading hierarchy worth a quick double-check.

Important Files Changed

Filename Overview
docs/documentation/platform/pr-workflows.mdx Revamped approval workflows doc into a structured how-to guide; contact email changed from sales@ to team@infisical.com inconsistently with most other docs; heading levels skip H3 inside Steps; sidebarTitle is redundant.
docs/docs.json Moved pr-workflows page from Access Controls nav group to Secrets Management > Product Reference; the placement looks correct.

Reviews (1): Last reviewed commit: "Removed agent folder as that's still WIP" | Re-trigger Greptile

Comment thread docs/documentation/platform/pr-workflows.mdx Outdated
Comment thread docs/documentation/platform/pr-workflows.mdx Outdated
Comment thread docs/documentation/platform/pr-workflows.mdx
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
jakehulberg and others added 2 commits March 31, 2026 16:36
…files

Move access-requests to Product Reference in Secrets Management nav.
Remove pipeline output artifacts and duplicate remediated file.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ols overview

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jakehulberg and others added 2 commits April 7, 2026 06:30
@jakehulberg jakehulberg merged commit 46ea75d into main Apr 7, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants