Skip to content

docs: add a stability page for 1.0 - #252

Merged
x-ror merged 2 commits into
mainfrom
docs/stability
Nov 14, 2026
Merged

x-ror merged 2 commits into
mainfrom
docs/stability

Conversation

@x-ror

@x-ror x-ror commented Nov 14, 2026

Copy link
Copy Markdown
Owner

A Reference page that says what 1.0 keeps stable under SemVer. Merge after the contract PR (feat/contract-1.0): the page promises its department-switch behaviour (A1).

  • Covered:
    • rule names and departments, including Syntax/* and Config/Invalid;
    • the .ruby-templates.toml schema and defaults;
    • CLI subcommands, flags, exit codes and --format output shapes;
    • VS Code setting, command and language ids.
  • Not covered: message text, which cases a rule reports, --verbose output, the LSP protocol between extension and server, and experimental features (Liquid).
  • Rules in minor versions:
    • New rules ship off by default or at information severity, and a department's enabled = true doesn't turn them on.
    • Severity can be lowered in a minor version and raised only in a major one.
    • Formatter output changes only to fix wrong output.
  • Versions and deprecations:
    • One version number covers the extension, the CLI and the server.
    • Deprecations come with a note in at least one minor version before removal in a major one.

The site build wasn't run locally (Astro needs a newer Node); CI builds it. format:check passes.


Generated by Claude Code

1.0 freezes rule names, the config file, the command line and the
VS Code ids, so users need to know what SemVer covers, what may still
change in a minor version (messages, the LSP surface, Liquid), and how
new rules, severities, formatter output and deprecations are handled
without breaking a CI run that passed before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012jSfzj1UNFUHV9YmmbjLg4
The audit's change that a department's enabled = true only restores
rules that are on by default is approved, so the page can promise it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012jSfzj1UNFUHV9YmmbjLg4
@x-ror
x-ror merged commit 81ac748 into main Nov 14, 2026
17 checks passed
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.

2 participants