Skip to content

docs: @marko/tree-sitter name + writing guidelines#2

Merged
DylanPiercey merged 1 commit into
mainfrom
docs/package-name-and-style
Jun 13, 2026
Merged

docs: @marko/tree-sitter name + writing guidelines#2
DylanPiercey merged 1 commit into
mainfrom
docs/package-name-and-style

Conversation

@DylanPiercey

Copy link
Copy Markdown
Contributor
  • README now references the published package name @marko/tree-sitter instead of the old tree-sitter-marko (the npm install/require example pointed at the wrong package). The tree-sitter-marko.wasm filename is kept — that's the conventional tree-sitter-<lang>.wasm grammar-wasm name, not the package.
  • Apply the marko-js docs writing guidelines: remove all emdashes, drop second-person voice, and replace the **Bold**: description list in "Tag types" with prose.

- README references the published package name (@marko/tree-sitter) instead
  of the old tree-sitter-marko.
- Apply the marko-js docs writing guidelines: drop emdashes, remove
  second-person voice, and replace the bold-title list in Tag types with prose.
@DylanPiercey
DylanPiercey merged commit 1389646 into main Jun 13, 2026
8 checks passed
@DylanPiercey
DylanPiercey deleted the docs/package-name-and-style branch June 13, 2026 22:04
@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7984ff47-dc4c-43ce-a226-af3d929dba08

📥 Commits

Reviewing files that changed from the base of the PR and between 6f268a7 and fb1b46c.

📒 Files selected for processing (1)
  • README.md

Walkthrough

This PR updates README.md to reflect the package rename from tree-sitter-marko to @marko/tree-sitter, affecting the top-level heading and Node.js usage example. The documentation for editor integrations (tree-sitter CLI, Helix, Zed) is reformatted and expanded with clarification on grammar discovery mechanisms. Grammar reference sections covering structural notes, tag types, embedded language injection, and fidelity notes are rewritten for improved clarity and organization.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly summarizes the main changes: updating documentation to use the correct @marko/tree-sitter package name and applying writing guidelines.
Description check ✅ Passed The description clearly explains the rationale behind the changes, including the package name correction and the writing guidelines being applied.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/package-name-and-style

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

@github-project-automation github-project-automation Bot moved this to Todo in Roadmap Jul 14, 2026
@github-project-automation github-project-automation Bot moved this from Todo to Done in Roadmap Jul 14, 2026
@DylanPiercey DylanPiercey self-assigned this Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant