Skip to content

docs: cosign kms docs#5808

Merged
ashwin-infisical merged 1 commit intomainfrom
sigstore-docs
Mar 25, 2026
Merged

docs: cosign kms docs#5808
ashwin-infisical merged 1 commit intomainfrom
sigstore-docs

Conversation

@varonix0
Copy link
Copy Markdown
Member

Context

Added on-site documentation for Cosign KMS built on our existing docs. https://github.com/Infisical/sigstore-kms-infisical

Steps to verify the change

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • Docs
  • Chore

Checklist

  • 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).
  • Tested locally
  • Updated docs (if needed)
  • Updated CLAUDE.md files (if needed)
  • Read the contributing guide

@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 25, 2026

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

Project Status Preview Updated (UTC)
infisical 🟢 Ready View Preview Mar 25, 2026, 3:48 PM

@maidul98
Copy link
Copy Markdown
Collaborator

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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 25, 2026

Greptile Summary

This PR adds a new documentation page (sigstore-cosign.mdx) for the Infisical KMS + Sigstore Cosign integration, along with the corresponding docs.json navigation entry. The content is accurate and covers the core use cases (install, configure, sign, verify, generate key pair) well.

A few polish items worth addressing before merge:

  • Header hierarchy: The ### KMS Plugin Capabilities section uses a third-level heading above ## Setup / ## Usage, which is inverted. Per Mintlify best practices, top-level sections with nested sub-sections should use #, not ##, so the sidebar nesting renders correctly.
  • Missing Go prerequisite: The install step runs go build without noting that Go must be installed first, which will confuse users who don't have it.
  • Inconsistent placeholder style: The environment variable examples use <angle-bracket> placeholders while the cosign command examples use {curly-brace} placeholders — pick one style throughout for clarity.

Confidence Score: 4/5

  • Safe to merge; all issues are non-blocking documentation style improvements.
  • The PR is purely documentation — no code changes, no security implications, and no breaking changes. The three flagged items (header hierarchy, missing Go prerequisite, placeholder inconsistency) are all polish-level P2s that don't prevent users from following the guide. The core content is accurate and complete.
  • docs/documentation/platform/kms/sigstore-cosign.mdx — minor header hierarchy and style fixes recommended.

Important Files Changed

Filename Overview
docs/documentation/platform/kms/sigstore-cosign.mdx New documentation page for the Sigstore Cosign KMS plugin. Content is accurate and complete, with minor style issues: inverted header hierarchy (### before ##), missing Go prerequisite note, and inconsistent placeholder formatting between sections.
docs/docs.json Adds sigstore-cosign to the KMS section of the sidebar navigation. The entry is correctly placed and formatted.

Reviews (1): Last reviewed commit: "docs: sigstore kms docs" | Re-trigger Greptile

Copy link
Copy Markdown
Collaborator

@ashwin-infisical ashwin-infisical left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@ashwin-infisical ashwin-infisical merged commit 8a9baef into main Mar 25, 2026
8 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