Skip to content

docs: changelog + M27 scoring & replay updates#5

Merged
indykish merged 5 commits intomainfrom
feat/m27-changelog-and-scoring-docs
Apr 5, 2026
Merged

docs: changelog + M27 scoring & replay updates#5
indykish merged 5 commits intomainfrom
feat/m27-changelog-and-scoring-docs

Conversation

@indykish
Copy link
Copy Markdown
Contributor

@indykish indykish commented Apr 4, 2026

Summary

  • Add changelog.mdx with Mintlify <Update> components — product updates for April 5, March 30, March 28, March 25
  • Update runs/scorecard.mdx — resource efficiency axis is live (was stubbed), plain-language description, updated API example
  • Update runs/troubleshooting.mdx — replay is shipped (was "coming soon"), add CLI and API examples
  • Add Changelog to navbar (before "Talk to us") and sidebar navigation
  • Link billing "coming soon" note to changelog

Test plan

  • Mintlify preview renders changelog with <Update> components
  • Navbar shows Changelog link before "Talk to us"
  • Scorecard page no longer mentions "stubbed" or "Firecracker"
  • Troubleshooting replay section shows actual usage, not "planned"

🤖 Generated with Claude Code

- Add changelog.mdx with Mintlify Update components (product updates format)
- Update scorecard: resource efficiency axis is now live (remove stub notice)
- Update troubleshooting: replay is shipped, not "coming soon"
- Add Changelog link to navbar and sidebar navigation
- Link billing "coming soon" note to changelog

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Apr 4, 2026

Greptile Summary

This PR ships M27 release documentation: a new changelog page, updated scorecard docs for the live resource efficiency axis, and updated troubleshooting docs scoping run replay to API-only (with CLI noted as planned). Navigation is updated to surface the changelog in both the navbar and sidebar.

  • changelog.mdx — Four dated entries using Mintlify <Update> components. The March 30 entries correctly scope streaming and replay to the API, explicitly noting that CLI support (--watch and zombiectl runs replay) is coming in a future release — making these entries consistent with the existing "planned for a future release" notes in cli/zombiectl.mdx (lines 171, 197) and runs/submitting.mdx (lines 21–25). No contradiction remains.
  • runs/scorecard.mdx — Resource efficiency axis is fully documented (memory 70%, CPU 30% sub-weights; defaults to 50 when data is unavailable). API response example updated to formula version "2" with resource_efficiency included in the axes breakdown.
  • runs/troubleshooting.mdx — Run replay section now shows the live API curl example with a <Note> that the CLI command (zombiectl runs replay) is planned, rather than presenting the entire section as coming soon.
  • docs.json — Changelog added to the navbar before "Talk to us" and to a new "Updates" sidebar group containing changelog.
  • billing/plans.mdx — The "coming soon" note for non-billable Bronze runs now links to /changelog so users can track the rollout.

Confidence Score: 5/5

Safe to merge — all doc changes are internally consistent and no contradictions remain.

Documentation-only PR with no logic bugs. The changelog explicitly scopes streaming and replay to API-only with CLI flagged as planned, which is now consistent with the existing 'planned for a future release' notes in cli/zombiectl.mdx and runs/submitting.mdx. No P0 or P1 findings.

No files require special attention.

Important Files Changed

Filename Overview
changelog.mdx New changelog page; March 30 entries correctly scoped to API-only with CLI explicitly flagged as planned for a future release
runs/scorecard.mdx Resource efficiency axis fully documented with memory/CPU sub-weights and formula v2 API response example
runs/troubleshooting.mdx Replay section scoped to API-only curl example with Note that CLI command is planned — consistent with changelog
docs.json Changelog added to navbar before 'Talk to us' and to sidebar 'Updates' group
billing/plans.mdx Adds /changelog link to the 'coming soon' note for non-billable Bronze runs

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    DJ[docs.json] -->|navbar + sidebar| CL[changelog.mdx]
    CL -->|April 5| SC[runs/scorecard.mdx\nResource efficiency live]
    CL -->|March 30 API-only| TR[runs/troubleshooting.mdx\nReplay curl example + CLI planned note]
    CL -->|future feature tracking| BP[billing/plans.mdx\nLinks to /changelog]
    SC -->|formula_version 2| API[API response example]
    TR -->|GET /v1/runs/id:replay| API
Loading

Reviews (4): Last reviewed commit: "docs: mark zombiectl runs replay as plan..." | Re-trigger Greptile

indykish and others added 2 commits April 5, 2026 08:31
…replay

Both features are live in the released npm build. Fixes contradictions
flagged in greptile review of PR #5.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
indykish and others added 2 commits April 5, 2026 09:14
… coming soon

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…not yet in npm

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@indykish indykish merged commit e983f0f into main Apr 5, 2026
4 checks passed
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