|
| 1 | +# OrgScript v0.6.0 |
| 2 | + |
| 3 | +OrgScript v0.6.0 is the first **integrations, artifacts, and showcase** release. |
| 4 | + |
| 5 | +This release marks a major step forward in making OrgScript’s value proposition visible. Instead of just modeling and checking logic, you can now generate compelling visual and structured outputs for stakeholders, documentation, and external systems. |
| 6 | + |
| 7 | +## Highlights |
| 8 | + |
| 9 | +### HTML Documentation Export |
| 10 | +- Introduced `orgscript export html <file>`. |
| 11 | +- Generates a modern, static HTML documentation page. |
| 12 | +- Features embedded logic summaries and live-rendered Mermaid diagrams via CDN-based `mermaid.js`. |
| 13 | + |
| 14 | +### Mermaid Export Polish |
| 15 | +- **Semantic Shapes**: Triggers are now represented as parallelograms for better flowchart clarity. |
| 16 | +- **Improved Styling**: Added a consistent and premium styling layer (color-coded nodes for decision, action, trigger, success, and stop). |
| 17 | +- **Stateflow Markers**: State diagrams now include proper `[*] -->` (start) and `--> [*]` (end) markers based on transition flow. |
| 18 | +- **Readability**: Switched to single quotes for internal strings to improve the raw output's legibility. |
| 19 | + |
| 20 | +### Markdown Summary v2 |
| 21 | +- **TOC and Anchors**: Multi-block files now include a Table of Contents with jump-links. |
| 22 | +- **Structured Sections**: Blocks are now separated by horizontal rules and use a clearer header hierarchy (H2/H3). |
| 23 | +- **Business Language**: Phrasing has been tuned to be less technical and more accessible for non-technical reviewers. |
| 24 | + |
| 25 | +### Showcase Upgrade |
| 26 | +- Updated `docs/demos/` to include HTML, Markdown, and Mermaid artifacts. |
| 27 | +- Included the "Hero" example (`craft-business-lead-to-order.orgs`) in the demo build. |
| 28 | +- Refined the "Strategic Artifact Flow" described in the root `README.md`. |
| 29 | + |
| 30 | +## Integration and Governance |
| 31 | +- **Canonical Model v0.2**: Stabilized the JSON schema for tokens, expressions, and block nodes. |
| 32 | +- **Reference Spec**: Updated `spec/canonical-model.md` to match the real-world implementation. |
| 33 | +- **Stability Policy**: Clarified policy for breaking changes in machine-readable outputs. |
| 34 | + |
| 35 | +## Verification |
| 36 | + |
| 37 | +Verified on the current release state with: |
| 38 | + |
| 39 | +- `npm test` |
| 40 | +- `npm run check:all` |
| 41 | +- `node ./bin/orgscript.js export html ./examples/craft-business-lead-to-order.orgs` |
| 42 | +- `node ./bin/orgscript.js demo:generate` |
| 43 | + |
| 44 | +## Project Status |
| 45 | + |
| 46 | +v0.6.0 transforms OrgScript from a stable specification into a useful documentation engine. By providing high-quality, zero-config exporters for the Web (HTML) and for prose (Markdown), we are establishing OrgScript as a credible layer for organizational knowledge and process governance. |
0 commit comments