Proofread quick-start.md #837
Conversation
I did some proofreading and grammar checking on the quick start. Hopefully this is helpful since most users will land here first!
WalkthroughEditorial rewrite of Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
website/guide/quick-start.md (9)
11-11: Grammar tweak for flow and idiomSuggest tightening the sentence.
-You can unleash `ast-grep`'s power from your fingertips within few keystrokes at the command line! +You can unleash `ast-grep`'s power at your fingertips in a few keystrokes on the command line!
13-13: Smoother phrasingMinor style improvement.
-Let's try its power by rewriting some code in a moderately large codebase: [TypeScript](https://github.com/microsoft/TypeScript/). +Let's see it in action by rewriting code in a moderately large codebase: [TypeScript](https://github.com/microsoft/TypeScript/).
15-15: Idiomatic order: “shiny new”Reads more naturally.
-...to use the new shiny [optional chaining operator]... +...to use the shiny new [optional chaining operator]...
75-77: Clarify intent and fix hyphenationTighten wording and remove unnecessary hyphen.
-Let's search for occurrences of looking up a method from a nested structure. `ast-grep` uses **patterns** to find similar code. -Think of it as the pattern in our old-friend `grep`, but instead of text, it matches AST nodes. +Let's search for instances of calling a method on a nested property. `ast-grep` uses **patterns** to find similar code. +Think of patterns like those in our old friend `grep`, but instead of text, they match AST nodes.
96-98: Metavariable terminology + grammarUse “metavariables,” one word “uppercase,” and fix “Think it as.”
-Exact matching based on the AST is cool, but we can go further with **meta variables** which allow for more flexibility. -We can use **meta variable** to match any single AST node. Meta variables begin with the `$` sign and use upper case letters, e.g. `$METAVAR`. -Think it as REGEX dot `.`, except it is not textual. +Exact AST matching is powerful, but we can go further with **metavariables** for more flexibility. +Use a **metavariable** to match any single AST node. Metavariables begin with `$` and are typically uppercase (e.g., `$PROP`). +Think of it like the regex dot `.`, except it matches syntax nodes, not text.If ast-grep enforces uppercase-only metavariables (vs. convention), we should state that explicitly. Want me to verify against current docs and update the wording?
106-108: Tighten CLI option wordingMinor clarity improvement.
-This is a valid `ast-grep` pattern that we can use from the command line! The `pattern` argument specifies our target. -Optionally, we can use `lang` to tell `ast-grep` our target code language. +This is a valid `ast-grep` pattern you can run from the command line. The `--pattern` argument specifies the target. +Optionally, use `--lang` to specify the target language.
123-127: Quoting guidance: plural and articleMinor grammar improvements.
-The pattern must be quoted by single quote `'` to prevent shell from interpreting `$` sign. +The pattern must be enclosed in single quotes `'` to prevent the shell from interpreting the `$` sign. @@ -With double quotes `ast-grep -p "$PROP && $PROP()"` the command would be interpreted as `ast-grep -p " && ()"` after shell expansion. +With double quotes, `ast-grep -p "$PROP && $PROP()"` would be interpreted as `ast-grep -p " && ()"` after shell expansion.
146-146: Consistency: “TypeScript source” vs. “TypeScript’s repository”Earlier you used “TypeScript source.” Keep terminology consistent.
-That's it! You have refactored TypeScript's repository in minutes. Congratulations! +That's it! You have refactored the TypeScript source in minutes. Congratulations!
148-148: Smooth the closing sentenceMinor grammar and hyphenation fixes.
-We hope you enjoy the power of AST editing in plain programming language pattern. The next step is to learn more about writing patterns. +We hope you enjoy the power of AST editing with plain programming-language patterns. Next, learn more about writing patterns.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
website/guide/quick-start.md(5 hunks)
🔇 Additional comments (4)
website/guide/quick-start.md (4)
100-100: Good clarificationClear statement of the search goal. LGTM.
110-119: Command examples read wellExamples are accurate and consistent (short/long forms, with and without
--lang). LGTM.
131-131: Nice transitionEngaging segue into the rewrite section. LGTM.
142-142: Clear UX noteGood explanation of interactive mode. LGTM.
2 participants
I did some proofreading and grammar checking on the quick start. Hopefully this is helpful since most users will land here first!
Summary by CodeRabbit
$, typically uppercase).