Repository navigation
Check Rue examples in-repo and add an update-rue-docs skill - #13
Merged
Merged
Conversation
This file contains hidden or 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
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.
Adds an
update-rue-docsskill to run each time a new Rue version is released, modelled onupdate-sdk-docsin xch-dev/docs. It also adds a check that compiles every Rue example in the docs, which the skill relies on.Changes
.claude/skills/update-rue-docs/SKILL.md: run it as/update-rue-docs [version]. It covers:.rue-versionto the target;.rue-version: records the Rue version the docs describe (0.12.0).pnpm check:rue-examples(scripts/check-rue-examples.py): checks every```rueblock with therueCLI. Each block must:test fnpass;main;rue fmtformats it.The info string after
ruechanges what's checked:ignoreskips the block (fragments, multi-file examples);errormeans the block must fail to compile;warnallows warnings;nofmtskips the format check.The script fails if the CLI isn't the version in
.rue-version.--rue <path>points it at a specific binary.Docs:
rue fmtstyle.nofmt, becauserue fmtbreaks its long signature insideList<Condition>instead of between the parameters (rue fmt breaks inside the return type's generic arguments instead of between the parameters rue#322).CI: a new
rue-examplesjob installsrue-cliat the version in.rue-versionand runs the check. The binary is cached per version, so the few-minutecargo installonly happens when the version changes.README: documents the example check and the skill.
Note
Low Risk
Adds a script, a CI job and a skill, and only adds info strings and formatting changes to existing examples, so the rendered docs are unchanged apart from the reformatted tutorial snippets. Prettier, typecheck and build pass. The new CI job only reads the repo and installs a pinned crates.io version. The check passes against 0.12.0 and catches each kind of failure in a throwaway test page.
scripts/check-rue-examples.py,.rue-version, acheck:rue-examplesscript inpackage.json, and therue-examplesCI job..claude/skills/update-rue-docs/SKILL.md.