docs: refresh controls tutorial for flow templates, coverage, and CLI#301
docs: refresh controls tutorial for flow templates, coverage, and CLI#301pbeckham wants to merge 1 commit into
Conversation
Update the working-with-controls tutorial to match released behavior (issue #6005): document requiring decisions in flow templates, the new Coverage tab and coverage API, control archiving semantics (controls, environments, and policies), and the controls CLI commands (create, update, list, get, archive, unarchive, tag). Replace the catalog, decisions, and decision-detail screenshots and add a coverage screenshot, all cropped to app content. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @pbeckham's task in 2m 48s —— View job PR Review: Refresh controls tutorial
Overall assessmentThis is a solid tutorial update. The new sections (flow templates, coverage, archiving, CLI commands) are well-written, follow Diátaxis tutorial conventions, and integrate naturally into the existing page structure. Writing style is consistent with CLAUDE.md conventions: active voice, imperative mood, correct product terminology, American spelling. All internal links resolve to existing pages or configured redirects. The screenshots are clear, match the UI descriptions in the text, and show relevant features (coverage progress bar, Status filter, Decisions/Coverage/Versions tabs). FindingsNo Critical issues found. Improvement
Suggestions
Merge noteThe PR description clearly flags the CLI-release dependency — CLI commands are referenced as inline code (not links) to avoid broken links until the SummaryClean, well-structured update. No broken links, no relative links, no navigation gaps. The new coverage section and flow-template section are particularly useful additions that explain the distinction between trail-scoped and environment-scoped requirements clearly. Ready to merge once the CLI is released. |
Closes #6005.
Refreshes the Working with controls tutorial to match released behavior.
What changed
type: decisionattestations, and how that differs fromfor_controlin environment policies.for_control, regardless of pass/fail), the coverage %, the Status filter, and theGET /api/v2/controls/{org}/{identifier}/coverageAPI.kosli create / update / list / get / archive / unarchive / tag controlcommands, with examples.controls-list,controls-decisions,controls-decision-detailand addedcontrols-coverage, all cropped to app content.The
kosli *control*commands are merged to the CLImainbut not yet in a released binary, so the auto-generatedclient_reference/pages don't exist yet — the commands are referenced as inline code (not links) to avoid broken links. Please merge this only after the CLI is tagged; a follow-up can convert the inline references to links once the reference pages regenerate.🤖 Generated with Claude Code