Skip to content

v0.5.0 - Editor, Adoption, Polish

Choose a tag to compare

View all tags
@DKFuH DKFuH released this 29 Mar 10:49
· 58 commits to main since this release
v0.5.0
f7ac3c2

v0.5.0 Roadmap [COMPLETED]

Milestone title: v0.5.0 - Editor, Adoption, Polish

Goal

Make OrgScript feel immediately usable for new contributors and early adopters without expanding the language surface.

Release focus

  • editor usability
  • README and demo clarity
  • curated example quality
  • diagnostics and CLI polish
  • lightweight language governance

Why now

v0.4.0 established the core developer-experience baseline:

  • format --check
  • check and check --json
  • stable diagnostics with documented codes
  • Markdown summary export
  • Mermaid demos
  • canonical language spec
  • governance notes and usage guides
  • first usable VS Code syntax highlighting

The next step is not more syntax. The next step is adoption.

Planned issues

  1. feat(editor): improve VS Code syntax highlighting
  2. docs(readme): add a visual source-to-artifact showcase
  3. docs(examples): curate the example catalog
  4. enhancement(diagnostics): polish diagnostics UX
  5. docs(governance): add language evolution notes

Recommended order

  1. VS Code highlighting v2
  2. visual README showcase
  3. curated example catalog
  4. diagnostics UX polish
  5. language evolution notes

Workstreams

1. Editor

  • refine TextMate scopes
  • improve highlighting for block names, references, and operators
  • simplify local installation and testing notes
  • add one or two visual examples for the editor experience

2. Front door

  • show .orgs, Mermaid, and Markdown summary side by side
  • make check, validate --json, and lint --json easier to discover
  • shorten the path from repository landing to first successful command

3. Examples

  • curate three strong examples:
    • sales / lead flow
    • approval / finance
    • service / escalation
  • group examples into:
    • simple
    • realistic
    • advanced

4. Diagnostics and CLI polish

  • tighten wording of common messages
  • preserve diagnostic code stability
  • make check output easier to scan
  • keep text and JSON behavior aligned

5. Governance

  • define what belongs in the language core
  • define what should stay in exporters or tooling
  • state how breaking changes are handled
  • clarify how spec versioning and CLI versioning relate

Non-goals

  • new language keywords
  • localized syntax
  • major parser rewrites
  • SaaS or hosted tooling
  • enterprise-specific features
  • many new exporters at once

Success criteria

  • OrgScript feels easier to adopt in a first editor session
  • the README demonstrates visible value in under a minute
  • examples are easier to browse and compare
  • diagnostics feel more polished without changing the language core
  • language evolution decisions become easier to reason about

Next after v0.5.0

v0.6.0 should focus on integrations and generated artifacts:

  • Mermaid stabilization
  • richer Markdown or HTML docs
  • clearer exporter contracts
  • stronger source-to-artifact demo flows
Assets 2
Loading