feat: new Kosli Capture drop-in AWS snapshotting tutorial - #337
feat: new Kosli Capture drop-in AWS snapshotting tutorial#337mintlify[bot] wants to merge 20 commits into
Conversation
|
Claude finished @mbevc1's task in 3m 11s —— View job Doc review — PR #337
Good progress since the earlier review rounds — the Diátaxis split into tutorial + reference page is exactly the right call, the internal-audience language from tooky's review has been addressed, and the tutorial now reads as a clean deploy-verify-customize flow.
|
| Category | Finding |
|---|---|
| Improvement | Line 70: ## 3. Bootstrap the artefacts bucket — British spelling in prose heading. Should be "artifacts" per CLAUDE.md. (The Makefile target names on line 91 like prune-artefacts are fine as-is since they match the actual CLI.) Posted as inline comment with suggestion. |
| Suggestion | Line 96: "three places tell you Kosli Capture is doing its job" — slightly passive. Could use imperative: "check three places to confirm Kosli Capture is running". Minor; current version is clear enough. |
What's working well:
- Clean frontmatter, single short description
- All 14 internal links are root-relative and verified to exist
- No relative links
- Numbered steps (1–7) provide a clear deploy flow
- Good cross-linking to the new config reference page, including anchor links (
#grouping-lambda-and-ecs,#eks-namespaces,#config-sources-at-runtime) that match actual headings - "What you've accomplished" closing section with next steps
- Appropriate use of
<Info>and<Tip>callouts (not overused)
kosli-capture-reference/config.mdx
| Category | Finding |
|---|---|
| ✅ | No issues found |
Clean reference page. Tables, YAML examples, precedence chains, and rules are well structured. Cross-links back to the tutorial. No spelling issues, no relative links.
config/navigation.json
| Category | Finding |
|---|---|
| ✅ | Both new pages registered correctly |
- Tutorial: added under
Tutorials > Reporting environmentsalongsidereport_aws_envs,report_k8s_envs, andreport_cloud_run_envs— logical placement - Config reference: new
Kosli Capture Referenceitem under the Reference tab withcameraicon
Summary
| Critical | Improvement | Suggestion |
|---|---|---|
| 0 | 1 | 1 |
The pages are in good shape. One British-spelling fix in a heading is the only actionable item. The Diátaxis split, navigation placement, link integrity, and writing style all look correct.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
tooky
left a comment
There was a problem hiding this comment.
Editorial pass focused on internal-audience language — places where the doc reads like a design review or team-facing prototype note rather than customer docs. Themes: internal vocabulary ("onboarding story", "drop-in", "the honest part", "none of it blocking"), design-rationale asides written to pre-empt internal reviewers ("so a typo cannot sweep in everything", "never silently falls back"), implementation details customers don't need ("stdlib JSON, no PyYAML", "vendor into the deploy artefact"), and comparisons against the previous Terraform iteration that customers never saw ("no Terraform, no state bucket"). All comments carry ready-to-apply suggestion blocks. Where earlier review comments cover the same line (the intro paragraph, the "honest part" heading), mine build on rather than repeat them — including an anchor fix at line 248 that the heading rename would otherwise break. The config reference tables, precedence chain, S3 opt-in rationale, and the new region/architecture constraints all read well as-is.
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: Steve Tooke <steve@took.es>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Phase 1 of #393. Closes #395. One edit to config/navigation.json: no page files move, no URLs change, no redirects needed, revertible in this commit. A URL comes from the file path, not from sidebar position, so every one of the 207 pages keeps its address while changing tab. Replace the five tabs, which mixed four organizing principles, with seven named after subjects. Each carries a one-sentence membership test: - Discover Kosli (27) - the reader has not started yet: orientation, first run, learning, getting unstuck - Platform administration (21) - the reader is configuring Kosli itself for an organization - Risks & controls (10) - the reader is deciding what must be true, or proving it was - Environments and runtime (4) - the reader is reporting, or interpreting, what is actually running - Record evidence (15) - the reader is instrumenting a pipeline to produce evidence - Reference (129) - the reader knows what they want and needs exact syntax or values - Changelog (1) - what shipped Documentation held 61 pages across 8 groups spanning all four Diataxis types, with no rule for what belonged in it. Splitting Documentation from Reference by page form forced authors to classify a page before they could place it; naming tabs after subjects means one subject's four Diataxis needs sit in one tab, sorted by form inside it. Tab labels are sentence case per CLAUDE.md, so `Risks & controls` and `Environments and runtime` rather than the Title Case forms in #395. This resolves open decision 5 in the proposal and keeps Phase 0's casing work from being undone two tabs later. Every tab now carries an icon, clearing the last inconsistent-icons finding. Reference is unchanged beyond gaining an icon. H1: update-cli-nav.py:154-158 hard-codes `tab == "Reference"` and `item == "CLI Reference"` and exits 1 without them, so neither label can move. Three deviations from the proposal's group layout, all because the group it specifies would hold a single page and reintroduce what Phase 0 just removed: - Policies and Advanced evaluation are merged into `Policies and evaluation`. The proposal's policy-reference/* entries are cross-links, which stay in Reference. - Working with controls joins `Risks and controls` rather than heading a group of one. - Environments and runtime carries managing_environments/overview as a direct page beside `Reporting your runtime`. The proposal's `Infrastructure as code` group is omitted: its Terraform and Helm entry points are cross-links into Reference, so it would hold no pages of its own. The `Kosli Capture` and `How reporting works` groups are also omitted because all four of their pages are still in unmerged PRs (#380, #337, #391); those PRs now have an obvious home to land in, which was the argument for the tab. Verified: 207 pages before and after, set-identical with no duplicates; audit_navigation.py down to 1 advisory finding; pytest 44 passed; mint broken-links clean.
Adds a new tutorial page walking through how to use kosli-dev/kosli-capture as a drop-in to start snapshotting AWS runtime environments (ECS, EKS, Lambda, tagged S3) into Kosli quickly.
Structured after
tutorials/working_with_controls.mdx:Sourced from:
Added to nav under Reporting environments alongside the existing per-resource reporter tutorial.
Draft / do-not-merge as requested — this is for review with the team and a couple of customers first.
Generated by Mintlify Agent.
Requested by: marko@kosli.com via Slack
Mintlify session: slack_1778705097.340389_D0ALT8RK1CJ