Skip to content

Commit f7ac3c2

Browse files
committed
docs(roadmap): plan v0.6.0 milestone - integrations, artifacts, and showcase
1 parent 77a41f5 commit f7ac3c2

File tree

1 file changed

+115
-0
lines changed

1 file changed

+115
-0
lines changed

docs/roadmaps/v0.6.0.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# OrgScript v0.6.0 Roadmap
2+
3+
Status: Planned
4+
5+
## Theme
6+
7+
v0.6.0 focuses on integrations, generated artifacts, and showcase value.
8+
9+
The goal is to make OrgScript easier to demonstrate, easier to consume downstream, and more obviously useful in real workflows.
10+
11+
This is not a language-expansion release.
12+
It is an artifact and adoption release.
13+
14+
## Goals
15+
16+
- strengthen OrgScript as a source-to-artifact workflow
17+
- improve generated outputs
18+
- make demos and examples more compelling
19+
- increase downstream usability for documentation and integrations
20+
- keep the core language stable while improving surrounding value
21+
22+
## Planned work packages
23+
24+
### WP1 — Mermaid Export Polish
25+
Improve Mermaid output quality and consistency for both `process` and `stateflow`.
26+
27+
Scope:
28+
- review generated Mermaid readability
29+
- improve node/edge naming consistency
30+
- improve layout-friendliness where possible
31+
- tighten deterministic output behavior
32+
- extend golden coverage if needed
33+
34+
Expected result:
35+
Mermaid export becomes more presentation-ready and easier to embed in docs.
36+
37+
---
38+
39+
### WP2 — Markdown Summary v2
40+
Improve the generated Markdown summaries so they work better as lightweight documentation artifacts.
41+
42+
Scope:
43+
- improve summaries for multi-block files
44+
- make section ordering more deliberate
45+
- improve consistency across block types
46+
- keep the output concise and deterministic
47+
- avoid turning summaries into free prose
48+
49+
Expected result:
50+
Markdown export becomes more useful as reviewable documentation.
51+
52+
---
53+
54+
### WP3 — HTML Documentation Export
55+
Add a first HTML documentation export path.
56+
57+
Scope:
58+
- `orgscript export html <file>`
59+
- generate a simple, static HTML artifact
60+
- include at least:
61+
- title
62+
- block sections
63+
- readable summaries
64+
- optionally embedded Mermaid source or rendered-friendly sections
65+
- keep styling minimal and stable
66+
67+
Expected result:
68+
OrgScript can generate a shareable documentation artifact beyond CLI and raw Markdown.
69+
70+
---
71+
72+
### WP4 — Demo and Showcase Upgrade
73+
Turn demos into a stronger adoption asset.
74+
75+
Scope:
76+
- improve demo structure under `docs/demos/`
77+
- make source → Mermaid → summary → optional HTML flow explicit
78+
- add one or two especially strong showcase cases
79+
- ensure demo generation scripts stay aligned with actual exporter behavior
80+
- improve README references to demos
81+
82+
Expected result:
83+
The repository shows OrgScript’s value in a more immediate and compelling way.
84+
85+
---
86+
87+
### WP5 — Integration Contract Polish
88+
Strengthen downstream usability for tooling and integrations.
89+
90+
Scope:
91+
- review canonical model documentation
92+
- review exporter boundaries vs core language
93+
- tighten documentation for output stability where appropriate
94+
- clarify which outputs are intended for human consumption vs machine integration
95+
96+
Expected result:
97+
OrgScript becomes easier to integrate into external tooling and documentation pipelines.
98+
99+
## Explicit non-goals
100+
101+
v0.6.0 does not prioritize:
102+
- new language keywords
103+
- new block types
104+
- major parser redesign
105+
- multi-language syntax
106+
- IntelliSense or full IDE language services
107+
- SaaS/cloud features
108+
109+
## Success criteria
110+
111+
v0.6.0 is successful if:
112+
- OrgScript produces stronger downstream artifacts
113+
- demos become more convincing
114+
- generated outputs are easier to use in real documentation workflows
115+
- the language core remains stable while utility increases

0 commit comments

Comments
 (0)