docs: close the remaining description and hint-orientation gaps

[VeronicaSnyk]

Finishes Group B items 8 and 9 of the AI-readiness audit. 11 files.

Descriptions — 5 pages

These pages were added after the main description pass in #1757, so they never had one.

Page	Description
agentic-security-with-snyk-studio/README.md	How Snyk Studio embeds security directives into AI-assisted development workflows
snyk-cli/commands/fix.md	The snyk fix --agentic command, which applies and verifies vulnerability fixes
snyk-cli/commands/secrets-test.md	The snyk secrets test command, which scans for hard-coded secrets and credentials
snyk-ide-plugins-and-extensions/compatibility-matrix.md	Compatible Snyk CLI version ranges for each IDE plugin version released in the past 12 months
verify-domain-ownership/verify-with-dns-txt.md	How to verify domain ownership for a Snyk API & Web target with a DNS TXT record

I checked the two CLI command pages are hand-maintained before editing them — recent commits are from named authors, and they are not produced by tools/api-docs-generator. snyk-api/changelog.md is bot-generated (regenerated hourly by sync-api-docs), so it is excluded; a hand-added description there would be erased.

Orienting sentences — 6 pages

These are the pages #1777 could not fix mechanically. Each has a heading or list immediately after the opening hint, so there was no existing sentence to promote and one had to be written. Every sentence is drawn from what the page already documents:

 # Snyk CI/CDs

+Snyk integrates with continuous integration and continuous delivery (CI/CD) pipelines so you can fail a build, or report on it, when a scan finds issues.
+
 {% hint style="info" %}
 Snyk recommends using the CLI for CI/CD integrations for the following reasons:

The other five cover the two API migration guides, Broker install via Docker and via Helm, and Terraform AWS provider support.

Both items are now closed

• Hint orientation: 0 pages remaining. No page opens with a hint longer than 300 characters before any prose.
• Descriptions: only changelog.md remaining, which is generated and out of scope.

Verification

• All 11 frontmatter blocks parse as valid YAML
• Each page still has exactly one H1, and all {% hint %} tags remain balanced
• Frontmatter spacing preserved

Item 8 and 9 running totals

Descriptions: 68 in #1757, 60 generated by #1765, 5 here — every hand-authored published page now has one.
Hint orientation: 33 moved in #1777, 6 written here — 39 of 39.

---

Note

Low Risk
Documentation-only metadata and introductory sentences; no code, APIs, or configuration behavior changes.

Overview
Completes the AI-readiness audit by updating 11 hand-authored docs pages with no behavioral or product changes.

Frontmatter description is added on five pages that were published without metadata (Snyk Studio overview, snyk fix --agentic, snyk secrets test, IDE plugin compatibility matrix, and DNS TXT domain verification). CLI command pages now match the same pattern as other command reference docs.

Opening orienting prose is inserted immediately after the H1 on six pages that previously jumped straight into long {% hint %} blocks or lists: Snyk CI/CD overview, both API migration guides (List all Projects completed migration and V1 Issues → REST), Classic Broker install via Docker and Helm, and Terraform AWS provider support. Wording is taken from existing page content so readers (and tooling) get context before hints.

Minor frontmatter whitespace cleanup only; H1 structure and hint tags are unchanged.

^{Reviewed by Cursor Bugbot for commit a1bc0c8. Bugbot is set up for automated code reviews on this repo. Configure here.}

[snyk-io]

✅ 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
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

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

[cursor]

AI review

No style or structural issues found.

Verified: all 11 frontmatter descriptions and orienting sentences match the documented page content · valid YAML frontmatter across all touched files · single H1 structure and balanced hint tags maintained · terminology adheres to Snyk writing rules.

  

_{Sent by Cursor Automation: PR review for User Docs}

[cursor]

The current head commit a1bc0c8 is reviewed.

  

_{Sent by Cursor Automation: PR review for User Docs}