-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Topiary book: Overview of Tree-sitter grammars and queries #887
Conversation
|
@facundominguez I've added you as a reviewer as you made this point in #750. It's a good point to bring up, as the original was assuming too much; hopefully the context is clearer now. |
|
* Moved section on environment variables to Topiary CLI/Runtime dialogue * Not enough to write about RE Tree-sitter grammars, so combined with queries chapter
2d03c78
to
736520f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
otherwise LGTM
* Reorganisation * Moved section on environment variables to Topiary CLI/Runtime dialogue * Not enough to write about RE Tree-sitter grammars, so combined with queries chapter * Tree-sitter crash course * Added note about query syntax support
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay. I can follow what query files are now 🎉
I left a comment of something that you might want to address later on.
* Cherry-pick setup from 83b8abd * Update CHANGELOG and PR template * Decant `README` into Topiary Book (#885) * Add GitHub repo link to book config * WIP: Decant README into book * Update usage documentation verifier * WIP: Decant easier parts of reference and TTY playground from README * Preparing ground for capture name documentation * WIP: Plan lift of capture names from README * Reference/Capture names/Basics (first approx.) * Reference/Capture names/{Horizonal spacing,Indentation} (first approx.) * Reference/Capture names/Insertion and deletion (first approx.) * Reference/Capture names/{Vertical spacing,Scopes} (first approx.) * Decant guides into book * Topiary book: Overview of Tree-sitter grammars and queries (#887) * Reorganisation * Moved section on environment variables to Topiary CLI/Runtime dialogue * Not enough to write about RE Tree-sitter grammars, so combined with queries chapter * Tree-sitter crash course * Added note about query syntax support * Topiary Book: Tidy-up Guides (#890) * Add Yann's tutorial to the Guides Resolves #874 * Reworked "Adding a new language" * Reworked "Suggested query development workflow" * Harmonise capitalisation * Add disclaimer to "Adding a new language" * Make the input/expected iteration step clearer * Fixed reference for new numbering * Clarification on what's strictly necessary * Added note RE #query-name! Note: Link is broken in this PR; will be correct with #891 * Topiary Book: Capture names (#891) * Reworked intro * Reworked general advice * Reworked horizontal spacing * Apparently I can't spell horizontal :P * Reworked modification (formerly case) * Reworked insertion and deletion * Reworked indentation * Forgot to remove TODO from horizontal spacing * Applied Nicolas' suggestions * Reworked vertical spacing * Reworked scopes * Fixed link * Applied Yann's and Nicolas' suggestions * Documentation for the web playground (#897) Also mentioned it's out-of-development status; resolves #875 * Topiary Book: Contributing guide (#892) * Set up * Decant CONTRIBUTING.md into contributors' guide * Tidy up contributing guide FWIW... A lot is out-of-date, but I adjusted things as necessary * Note on contributing new language support Resolves #876 * s/represented/supported/ * Simple README * Topiary Book: Editorial sweep (#898) * Easy/cheap changes for consistency * Apparently links in PR descriptions don't work as expected :( * Document C/C++ toolchain dependency * Clean up relics * Topiary Book style guide * Edit wrt style guide * Small tweaks to style guide * Topiary book: Publish book to Topiary website (#906) * Build web playground from 'playground' branch * Build website * Remove website tasks from ci.yml and prepare website.yaml for deployment * Add Topiary Book as a Nix output derivation * Build book in CI * Setup Nix for website build and cache playground assets * Cache Nix build assets rather than the symlink to their directory * Update website landing page w/ link, etc. * Fudge to get caching to work (hopefully) * Another fudge for caching... * Meaningless change to show caching works (hopefully...) * Deploy website * Set book base URL
Overview of Tree-sitter grammars and queries (prompted by https://github.com/tweag/topiary/pull/750/files#r1961950658)
README
into Topiary Book #885