Skip to content

Ship an LLM syntax reference (cheatsheet.md) in the marko package#3392

Merged
DylanPiercey merged 1 commit into
mainfrom
ship-llms-md
Jul 11, 2026
Merged

Ship an LLM syntax reference (cheatsheet.md) in the marko package#3392
DylanPiercey merged 1 commit into
mainfrom
ship-llms-md

Conversation

@DylanPiercey

@DylanPiercey DylanPiercey commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Description

Adds a dense Marko 6 syntax reference written for coding agents and ships it in the published marko package (files entry). It covers the tags API golden rules, a canonical component to copy, control flow, async/streaming with <await>, components and attribute tags, client effects, and a DON'T table mapping wrong-dialect habits (React/Vue/Svelte/Marko 4–5) to their correct forms.

Publishing it inside the package gives tooling a stable path — node_modules/marko/cheatsheet.md — to point agents at when they write or fix Marko code (e.g. from compile errors or an AGENTS.md); companion PRs wire that up in @marko/vite and @marko/run.

The runtime-tags AGENTS.md tag workflow now includes keeping cheatsheet.md up to date when user-facing syntax or guidance changes.

Checklist:

  • I have read the CONTRIBUTING document and have signed (or will sign) the CLA.
  • I have updated/added documentation affected by my changes.
  • I have added tests to cover my changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KZUGLZL3YoBToFLSEv2Nys

@changeset-bot

changeset-bot Bot commented Jul 11, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: ab828f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@marko/runtime-tags Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 37 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0cbda505-ddc6-4d2b-a7c6-b09e160ace57

📥 Commits

Reviewing files that changed from the base of the PR and between 642c68d and ab828f8.

📒 Files selected for processing (5)
  • .changeset/ship-llms-reference.md
  • cspell.json
  • packages/runtime-tags/AGENTS.md
  • packages/runtime-tags/cheatsheet.md
  • packages/runtime-tags/package.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ship-llms-md

Comment @coderabbitai help to get the list of available commands.

A dense Marko 6 reference written for coding agents: the tags API
golden rules, a canonical component, control flow, async/streaming,
components and attribute tags, client effects, and a table of
wrong-dialect habits with their correct forms. Publishing it inside
the package gives tooling a stable path
(node_modules/marko/cheatsheet.md) to point agents at when they write
or fix Marko code. The runtime-tags AGENTS.md tag workflow now
includes keeping it up to date.
@DylanPiercey DylanPiercey changed the title Ship an LLM syntax reference (llms.md) in the marko package Ship an LLM syntax reference (cheatsheet.md) in the marko package Jul 11, 2026
@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.27%. Comparing base (642c68d) to head (ab828f8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3392   +/-   ##
=======================================
  Coverage   94.27%   94.27%           
=======================================
  Files         388      388           
  Lines       53446    53446           
  Branches     4311     4311           
=======================================
  Hits        50385    50385           
  Misses       3029     3029           
  Partials       32       32           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DylanPiercey DylanPiercey merged commit d734bd0 into main Jul 11, 2026
12 checks passed
@github-actions github-actions Bot mentioned this pull request Jul 11, 2026
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