FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

chore: fix ordering and a typo by mbevc1 · Pull Request #371 · kosli-dev/docs · GitHub

/ docs Public

chore: fix ordering and a typo - #371

Merged
mbevc1 merged 1 commit into
mainfrom
20260820_ordering_typo
Aug 20, 2026
ConversationCommits (1)ChecksFiles changed
Merged

chore: fix ordering and a typo#371
mbevc1 merged 1 commit into
mainfrom
20260820_ordering_typo

Conversation

mbevc1 commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Minor fixes following #370

mbevc1 added the bug Something isn't working label Aug 20, 2026
mbevc1 requested a review from a team as a code owner August 20, 2026 17:39

mintlify Bot commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Aug 20, 2026, 5:40 PM

claude Bot commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 1m 54s —— View job

Doc review — PR #371

  • Gather context (diff, CLAUDE.md)
  • Read changelog/index.mdx and verify ordering
  • Verify internal links resolve
  • Post review

No Critical findings. Two Suggestions, both posted inline. Nothing blocks merge.

changelog/index.mdx

What's verified good

  • Ordering fix is correct. Moving the CLI v2.37.0 block from below the Aug 17 Platform entry to Aug 18 makes the file strictly descending by label end to end — I checked all 40+ <Update> labels, no remaining inversions.
  • The "typo" is really a factual correctness fix. The old line said kosli create attestation-type and kosli update attestation-type accept --summary-json. There is no kosli update attestation-type — client_reference/ has only kosli_update_control, kosli_update_default-org, and kosli_update_service-account, and kosli create attestation-type is documented as "Create or update". Good catch.
  • New flag copy matches the reference. The --summary / --summary-json description, the repeatable 'NAME=EXPRESSION' form, the order-is-preserved note, and "The two flags cannot be combined" all line up with client_reference/kosli_create_attestation-type.md:28-50.
  • Links. Both are root-relative per CLAUDE.md. /getting_started/attestations and /client_reference/kosli_create_attestation-type both exist and are listed in config/navigation.json (line 325). The moved /faq/faq#empty-flag-values anchor still resolves to ## Empty flag values at faq/faq.md:120. No new pages added, so no navigation change needed.
  • Headings are sentence case; <Update> blocks follow the format in CLAUDE.md.

Suggestions (inline)

  1. Line 21 — /getting_started/attestations doesn't document summaries at all (no summary match on that page), so the first link is a dead end for the feature it's introducing. Add a short section there or keep only the reference link.
  2. Line 49 — within Aug 18 the order is now Platform → CLI → Terraform, but Platform comes last on every other shared date in the file. Moving this block above line 40 would match.

Note on the PR title — chore: fix ordering and a typo undersells the first hunk. It documents a previously-undocumented --summary flag, adds the mutual-exclusivity constraint, and adds a reference link. docs: or fix: would describe it more honestly; both are valid Conventional Commits types per CLAUDE.md.

Not run: mint broken-links — the CLI isn't installed in this runner. I verified each changed link's target by file path and navigation entry instead, which covers the links this PR touches but not the rest of the site.
· 20260820_ordering_typo

mbevc1 merged commit 1aee36d into main Aug 20, 2026
8 checks passed
mbevc1 deleted the 20260820_ordering_typo branch August 20, 2026 17:40
claude Bot reviewed Aug 20, 2026
View reviewed changes
Comment thread changelog/index.mdx
## New features

- **Custom attestation type summaries** — `kosli create attestation-type` and `kosli update attestation-type` now accept `--summary-json`, a JSON list of ordered `{name, expression}` entries. Each expression is a jq expression evaluated against the attestation payload, and Kosli renders the results as labeled rows on the attestation detail page. See [custom attestation types](/getting_started/attestations).
- **Custom attestation type summaries** — `kosli create attestation-type` now accepts `--summary`, a repeatable `'NAME=EXPRESSION'` entry (for example `--summary "Critical=.critical_count"`), and `--summary-json`, the same list given as a JSON array of `{name, expression}` entries. Each expression is a jq expression evaluated against the attestation payload, and Kosli renders the results as labeled rows on the attestation detail page, in the order given. The two flags cannot be combined. See [custom attestation types](/getting_started/attestations) and the [`kosli create attestation-type` reference](/client_reference/kosli_create_attestation-type).

claude Bot Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Suggestion — the rewrite is accurate: it matches client_reference/kosli_create_attestation-type.md:28-50 (repeatable --summary, JSON --summary-json, "The two summary flags cannot be combined"), and dropping kosli update attestation-type is a real correctness fix — that command doesn't exist, kosli create attestation-type is documented as "Create or update".

One loose end: the first link, /getting_started/attestations, doesn't mention summaries anywhere on the page (no summary match in getting_started/attestations.md). A reader following it for summary docs lands on nothing. Either add a short summaries section to that page or drop the link and keep only the reference link, which does cover it.

claude Bot reviewed Aug 20, 2026
View reviewed changes
Comment thread changelog/index.mdx

</Update>

<Update label="August 18, 2026" description="v2.37.0" tags={["CLI"]}>

claude Bot Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Suggestion — the date ordering fix is correct; the whole file is now strictly descending by label.

Within August 18 the order is now Platform → CLI → Terraform. On every other shared date in this file the Platform entry comes last: Aug 19 (CLI, Platform), Aug 14 (CLI, Platform), Jul 31 (CLI, Platform), Jul 28 (CLI, CLI, Platform), Jul 10 (Terraform, CLI, Platform), Jul 8 (CLI, Terraform, Platform). Moving this v2.37.0 block above the Aug 18 Platform entry (currently line 40) would match that convention.

Non-blocking — it only affects same-day grouping, not the date ordering this PR set out to fix.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

claude[bot] claude[bot] left review comments

Assignees

No one assigned

Labels

bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

Back | FazBrowse Home | New Git URL