Skip to content

docs: present compatibility to OverPy developers in plain language - #23

Merged
Teakowa merged 1 commit into
mainfrom
docs/compat-human
Aug 16, 2026
Merged

docs: present compatibility to OverPy developers in plain language#23
Teakowa merged 1 commit into
mainfrom
docs/compat-human

Conversation

@Teakowa

@Teakowa Teakowa commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Closes #22

Summary

Rework the human-facing compatibility presentation in the README so an OverPy developer can see current support without learning WrightKit's internal state taxonomy.

Changes

  • Replaced the compatibility table (Capability | Matrix scope | State) and the internal state legend with a concise capability table using only ✅ Supported / 🟡 Partial / ⏳ Not yet, described in OverPy terms (core syntax, declarations, preprocessing, JavaScript macros, rules, builtins, receiver/member functions, enums, switch/string modifiers, advanced directives, OPY→Workshop, Workshop→OPY).
  • Removed Matrix scope and the internal state vocabulary (frontend-supported, semantic-supported, lowering-dependent, …) from the README body; the machine-readable matrix and per-feature evidence remain in docs/opy/support-matrix.md + compatibility/support-matrix.json and are linked from the compatibility section.
  • Reworded the intro to present opy-rs as WrightKit's standalone Rust implementation of OverPy, and trimmed internal terms (Opy HIR v1, manifest-declared) from the primary path.
  • No support-state data, corpus, or compatibility claims changed.

Validation

  • No internal support-state vocabulary or Matrix scope remains in the README body.
  • All relative links resolve; 0 em/en dashes.
  • Each table row maps to the existing matrix states without changing claims (✅ = frontend/semantic-supported, 🟡 = declared subset supported with full surface planned, ⏳ = planned or workshop-rs-dependent).

Rework the README compatibility section around a concise capability table using only Supported / Partial / Not yet as user-facing statuses, in OverPy terms. Remove the machine support-state vocabulary and Matrix-scope column from the README path and link to the evidence matrix instead. No support-state data or compatibility claims changed.
@Teakowa
Teakowa marked this pull request as ready for review August 16, 2026 19:44
@Teakowa
Teakowa merged commit 32010c5 into main Aug 16, 2026
4 checks passed
@Teakowa
Teakowa deleted the docs/compat-human branch August 16, 2026 19:46
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.

Simplify human-facing OverPy compatibility documentation

1 participant