Skip to content

docs(cli): follow the docs site move to /cli and generate the command reference as Markdown - #3457

Merged
migmartri merged 2 commits into
mainfrom
miguel/pfm-7370-trace-init-docs-url
Sep 21, 2026
Merged

migmartri merged 2 commits into
mainfrom
miguel/pfm-7370-trace-init-docs-url

Conversation

@migmartri

@migmartri migmartri commented Sep 20, 2026 •

Copy link
Copy Markdown
Member

CLI documentation links, following the move of the docs site to /cli in chainloop-dev/platform-docs#693.

1. trace init points at the AI sessions guide

The "Learn more" line printed at the end of chainloop trace init now points at docs.chainloop.dev/ai-sessions instead of the older trace guide.

2. The command reference is generated as Markdown, not MDX

The OSS command reference is no longer published to the documentation site: platform-docs#693 deleted the page and removed the job that synced this file into it. It is now read in this repository, so it is generated as plain Markdown.

  • cli-reference.mdx becomes cli-reference.md.
  • The Mintlify front matter is replaced by a Markdown title, and the <Note> component by a blockquote.
  • The Enterprise Edition link in that note becomes an absolute URL. A site-relative link resolved against the documentation site; in this repository it does not resolve at all.

The body was already plain Markdown from Cobra, so it is unchanged apart from the header.

3. The root command links to that reference

chainloop --help now ends its description with a link to the generated reference in this repository. The documentation site publishes the Enterprise Edition reference, which documents a different set of commands, so linking there would send readers to the wrong page.

4. Remaining links follow the new docs layout

  • app/cli/cmd/root.go — telemetry link, now /cli/telemetry.
  • docs/examples/policies/quickstart/README.md — policy reference link, now /cli/reference#chainloop-policy. The OSS page it pointed at is deleted; the #chainloop-policy anchor exists on the Enterprise Edition reference.

No command-line-reference path remains in the repository. The old URLs still redirect, so nothing here was broken; these are stale rather than dead links.

Related to https://linear.app/chainloop/issue/PFM-7370.

AI assistance: this change was produced with Claude Code.

🤖 Posted by Maximus bot (Claude Code) on behalf of @migmartri

Assisted-by: Claude Code
Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>

Chainloop-Trace-Sessions: bfb0b23d-bd11-4f59-bde7-51ae13e60168
@chainloop-platform

chainloop-platform Bot commented Sep 20, 2026 •

Copy link
Copy Markdown
Contributor

AI Session Checks — 🟡 85% · ⚠️ 1 failing

Avg score Sessions Failing policies Attribution Files Lines Total Duration
🟡 85% 1 ⚠️ 1 100% AI / 0% Human 6 +4310 / -4300 56m41s

🟡 85% — 100% AI — ⚠️ 1 policies failing

Sep 20, 2026 18:41 UTC · 56m41s · $7.13 · 212 in / 48.1k out · claude-code 2.1.278 (claude-opus-5)

View session details ↗

Change Summary

  • Updates trace init to point its "Learn more" link at docs.chainloop.dev/ai-sessions.
  • Converts the generated CLI reference from cli-reference.mdx to cli-reference.md and updates the generator.
  • Points root help and a quickstart doc at the in-repo CLI reference, and refreshes a stale telemetry docs link.

AI Session Overall Score

🟡 85% — Good execution overall, but planning and final confirmation stayed lighter than the task warranted.

AI Session Analysis Breakdown

🟢 92% · alignment

🟢 AI clarified the ambiguous root-command ask before editing. · High Impact

🟢 90% · solution-quality

🟢 AI changed the generator and regenerated docs instead of hand-editing output. · High Impact

🟢 88% · scope-discipline

No notes.

🟢 83% · user-trust-signal

No notes.

🟡 78% · verification

🟢 AI exercised the new root help output with a real go run --help. · High Impact

🟠 The user stayed active but never confirmed the final docs-link behavior worked. · Medium Severity

💡 When the user is still present, end by showing the final behavior and asking for explicit confirmation.

🟡 72% · context-and-planning

🟠 The multi-file docs follow-up had no written plan, TODO, or planning event. · Medium Severity

💡 For multi-file follow-ups, write a short shared plan before editing so scope and order stay visible.


File Attribution

████████████████████ 100% AI / 0% Human

Status Attribution File Lines
deleted ai app/cli/documentation/cli-reference.mdx +0 / -4287
created ai app/cli/documentation/cli-reference.md +4283 / -0
modified ai app/cli/cmd/root.go +15 / -3
modified ai app/cli/documentation/generate.go +10 / -8
modified ai app/cli/cmd/trace_init.go +1 / -1
modified ai docs/examples/policies/quickstart/README.md +1 / -1

Policies (4, 1 failing)

Status Policy Material Messages
✅ Passed ai-config-ai-agents-allowed ai-coding-session-bfb0b2 -
✅ Passed ai-config-no-dangerous-commands ai-coding-session-bfb0b2 -
✅ Passed ai-config-mcp-servers-allowed ai-coding-session-bfb0b2 -
⚠️ Failed ai-config-no-secrets ai-coding-session-bfb0b2
  • Secret (jwt) detected in session content [turn=111, source=tool_result, line=1]: [REDACTED:jwt]
  • Secret (jwt) detected in session content [turn=154, source=user-message, line=4]: Secret (jwt) detected in session content [turn=111, source=tool_result, line=1]: [REDACTED:jwt]
  • Secret (posthog-project-api-key) detected in session content [turn=284, source=tool_result, line=37]: posthogAPIKey = "[REDACTED:posthog-project-api-key]" // gitleaks:allow

Security Checks — ✅ 8 passing

✅ secret-scan

Status Policy Messages
✅ Passed secrets-detection -

✅ sast-scan

Status Policy Messages
✅ Passed owasp-top10-2025 -
✅ Passed sast -
✅ Passed cwe-top25 -
✅ Passed cwe-top26-40-cusp -

PR info

Status Policy Messages
✅ Passed pr-min-approvals -
✅ Passed pr-description-required -
✅ Passed pr-user-story-linked -

⏭️ 3 scans not applied

Scan Reason
vulnerability-scan no manifest/lockfile changed
github-actions-scan no workflow files changed
iac-scan no IaC files changed

View attestation ↗
View attestation ↗


Powered by Chainloop and Chainloop Trace

@migmartri
migmartri requested a review from a team September 20, 2026 18:44

@cubic-dev-ai cubic-dev-ai Bot left a comment

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.

No issues found across 1 file

Re-trigger cubic

The reference is no longer published to the documentation site, so it is
generated as plain Markdown rather than Mintlify MDX and the root command
links to the file in this repository instead of the Enterprise Edition
reference, which documents a different set of commands.

Assisted-by: Claude Code
Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>

Chainloop-Trace-Sessions: bfb0b23d-bd11-4f59-bde7-51ae13e60168
@migmartri migmartri changed the title fix(cli): point trace init guide to the AI sessions docs docs(cli): follow the docs site move to /cli and generate the command reference as Markdown Sep 20, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment •

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.

All reported issues were addressed across 4 files (changes from recent commits).

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread app/cli/cmd/root.go
@migmartri
migmartri requested a review from danlishka September 20, 2026 21:48
@migmartri
migmartri merged commit d65703c into main Sep 21, 2026
16 of 17 checks passed
@migmartri
migmartri deleted the miguel/pfm-7370-trace-init-docs-url branch September 21, 2026 09:00
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.

2 participants