Skip to content

Rewrite the docs for Rue 0.12.0 - #12

Merged
Rigidity merged 3 commits into
mainfrom
rigidity/rewrite-docs-rue-0-12-0
Nov 16, 2026
Merged

Rigidity merged 3 commits into
mainfrom
rigidity/rewrite-docs-rue-0-12-0

Conversation

@Rigidity

Copy link
Copy Markdown
Collaborator

Rewrites the docs to cover everything in Rue 0.12.0. Every claim was checked against the 0.12.0 compiler source and CLI, and every rue code block compiles with 0.12.0, except fragments, multi-file examples, and blocks that deliberately show an error.

Changes

  • New pages:
    • Projects: Rue.toml, how the CLI finds a project, and build --all
    • Command Line
    • Testing
    • Lints: levels, groups, Rue.toml, flags, attributes, expect, inner attributes, naming, and the full list of lints
    • Formatting
    • Standard Library
    • Generics
    • Casting
  • Rewritten pages:
    • Functions: external functions loaded from .hex files, lambdas, function types
    • Constants: const { } blocks
    • Control flow: else if, and the rules for if statements and return
    • Operators: >>>, BLS scalar multiplication, precedence
    • Modules: the file and super rules, re-exports
    • Every type-system page: literal types, length, list types, spread struct fields, recursive type rules, narrowing, and what guards can't check
    • Builtins: corrected signatures, unchecked_cast, INFINITY_G1/G2, coinid
    • Security
  • Tutorials: I ran both end to end with chia-wallet-sdk 0.38.0 (which uses Rue 0.12.0). They pass, so only their version notes changed.
  • Site:
    • The sidebar is grouped into Language, Type System and Tooling.
    • The navbar and footer have a Playground link.
    • The Rue highlighter now handles binary and octal literals and #[...] attributes.

Decisions to confirm

  • rue test <file>: the docs say it runs every test in the project the file belongs to, because that's what the 0.12.0 CLI does. The Rue README says only that file's tests run. If that's what the CLI is meant to do, the fix belongs in the CLI, and these docs should change with it.
  • No migration guide: the docs describe 0.12.0 only. A guide for moving from older versions could be added separately.

Note

Low Risk

Only documentation and site configuration change. CI's prettier, typecheck and build steps (which fail on broken links) all pass. The worst case is an inaccurate statement in the docs, and two review rounds checked the claims against the 0.12.0 compiler.

  • Docs: 8 new pages, and most of the existing pages rewritten.
  • Site config: the sidebar's structure, a Playground link in the navbar and footer, and Prism highlighting for Rue.

- Explain that a guard or cast must be parenthesized before combining it with |
- Document that rue test runs every test in the project, even when given a file
- Fix the duplicate_condition row in the lints table
- Correct claims about tree_hash on external functions, field access on struct unions, generic inference, Bool length, function type compatibility and BLS scalar multiplication
- Document dist_dir paths, export file names, the required [compiler] section, and that rue test doesn't check the version
- Match rue fmt style in examples, and link to the lints page for unused names
- Use an example of the _ placeholder where inference needs it
- Mention directories for rue test in the CLI page
- Format the security examples like rue fmt
@Rigidity
Rigidity merged commit 84efdae into main Nov 16, 2026
2 checks passed
@Rigidity
Rigidity deleted the rigidity/rewrite-docs-rue-0-12-0 branch November 16, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant