Topiary Book Super-PR #884
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Xophmeister
force-pushed
the
chris/book/base
branch
from
24bb5a1 to
c737587
Compare
This was referenced Mar 3, 2025
|
Note to self:
|
Do we still need the C/C++ toolchain since we switched to |
I believe so: |
* 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
* 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
* 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
* 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
Also mentioned it's out-of-development status; resolves #875
* 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/
* 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
Xophmeister
force-pushed
the
chris/book/base
branch
from
dca0118 to
6261219
Compare
* 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
|
Reviewers Please don't spend ages reviewing this meticulously; the sup-PRs have all been independently reviewed. |
|
I'm going to force this through, since the sub-PRs have been reviewed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Topiary Book Super-PR
Supersedes #750
Resolves #874
Resolves #875
Resolves #876
Description
This is the base/super-PR for the Topiary Book. Sub-PRs will hang off this and the idea is that they'll all be merged into this, before everything is merged into
main.READMEinto Topiary Book #885READMEto point to new documentationChecklist
Checklist before merging, wherever relevant:
CHANGELOG.mdupdatedREADME.md, etc.) up-to-date