Skip to content

docs: add tutorial for publishing trail summaries to GitHub and GitLab CI#274

Merged
mbevc1 merged 11 commits into
mainfrom
mintlify/trail-summaries-in-ci-rebased
Jun 18, 2026
Merged

docs: add tutorial for publishing trail summaries to GitHub and GitLab CI#274
mbevc1 merged 11 commits into
mainfrom
mintlify/trail-summaries-in-ci-rebased

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Rebased version of #272 onto current main, with the GitHub and GitLab sections converted to <Tabs> per review feedback.

Changes vs #272:

  • Rebased onto main (picks up the controls tutorial, CLI v2.27.0, June changelog, etc.).
  • Merged the separate ## GitHub Actions and ## GitLab CI sections under a single ## Publishing the summary heading and wrapped them in <Tabs> with <Tab title="GitHub" icon="github"> / <Tab title="GitLab" icon="gitlab">, matching the convention used in integrations/ci_cd.md and the client_reference pages.

Closes #272.


Generated by Mintlify Agent.

Requested by: marko@kosli.com via Slack
Mintlify session: slack_1781798784.812579_C0AJTQ5633K

@mintlify mintlify Bot requested a review from a team as a code owner June 18, 2026 16:11
@claude

claude Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mintlify[bot]'s task in 2m 0s —— View job


Review of PR #274

  • Read CLAUDE.md and doc-review skill
  • Read all changed files
  • Verify navigation config
  • Check links and conventions
  • Post review findings

Summary

This PR adds a well-structured tutorial for publishing trail summaries to GitHub Actions and GitLab CI, plus brings action versions and CLI version pins into alignment across the docs. The earlier automated review raised several valid issues — the commit history shows all of them were systematically addressed.

Navigation & structure

No issues. The new page tutorials/trail_summaries_in_ci is correctly added to config/navigation.json under the "Inspecting & querying" tutorial group. All internal links resolve to existing files:

Link Target exists?
/getting_started/install
/tutorials/querying_kosli
/getting_started/authenticating_to_kosli
/integrations/ci_cd#ci-runner-image-alpine ✅ (anchor matches heading)
/client_reference/kosli_get_trail
/integrations/ci_cd

No relative links found. All links are root-relative per CLAUDE.md.

Diátaxis classification

The page is a tutorial and follows the pattern correctly:

  • Clear learning goal stated upfront ("By the end of this tutorial, you will have…")
  • Prerequisites section
  • Step-by-step walkthrough
  • "What you've accomplished" wrap-up with next-step links

Version consistency

All action and CLI versions are now aligned across the docs:

Dependency Version Consistent?
actions/checkout @v7 ✅ (all 4 files)
kosli-dev/setup-cli-action @v5 ✅ (all 6 files)
kosli-runner image tag 2.28.0 ✅ (all references)
Pinned CLI in labs 2.28.0

Writing style & conventions

  • ✅ Frontmatter has title and description
  • ✅ Description is plain text (backticks stripped in 20139f8)
  • ✅ Active voice, imperative mood throughout
  • ✅ "Kosli" used correctly (not "the Kosli platform")
  • <Tabs>/<Tab> usage matches the convention in integrations/ci_cd.md

GitLab expose_as description

The earlier review flagged a mismatch between the description and the YAML. The current text accurately describes what expose_as does:

surfaces the summary.md artifact as a labeled link in the merge request widget, one click away from the rendered file in the GitLab UI.

This is correct — expose_as creates a labeled download/view link in the MR widget, and GitLab renders .md files when viewed. No factual mismatch remains.

Findings

No Critical or Improvement issues found.

Suggestion — consider noting that expose_as only appears on merge requests (1 item)

tutorials/trail_summaries_in_ci.md:73 — The expose_as link only appears in the merge request widget, not on standalone pipeline runs without an MR. Readers running pipelines on branches without an open MR won't see the link. A brief parenthetical like "(visible when a merge request exists for the pipeline)" could save them a debugging detour.

Overall assessment

Good to merge. The tutorial is well-written, follows Diátaxis conventions, and the version-alignment changes across existing pages are a welcome cleanup. The earlier review feedback has been fully addressed across the 11 commits.

Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
@mintlify

mintlify Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jun 18, 2026, 4:30 PM

Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread tutorials/trail_summaries_in_ci.md
Comment thread tutorials/trail_summaries_in_ci.md
Comment thread tutorials/trail_summaries_in_ci.md
Comment thread tutorials/trail_summaries_in_ci.md Outdated
Comment thread labs/lab-02-flows-and-trails.mdx
Comment thread tutorials/trail_summaries_in_ci.md
@mbevc1 mbevc1 merged commit 5513503 into main Jun 18, 2026
6 checks passed
@mbevc1 mbevc1 deleted the mintlify/trail-summaries-in-ci-rebased branch June 18, 2026 17:03
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.

1 participant