Skip to content

Commit fc1d959

Browse files
committed
docs(roadmap): add v0.7.0 - packaging, distribution, and trust
1 parent a954068 commit fc1d959

File tree

2 files changed

+56
-6
lines changed

2 files changed

+56
-6
lines changed

ROADMAP.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,30 @@
3737
- Improve consistency of human-readable CLI diagnostics
3838
- Add an initial VS Code syntax highlighting scaffold
3939

40-
## v0.5
40+
## v0.5 (Completed)
4141

4242
- Improve VS Code syntax highlighting and local testing flow
4343
- Add a visual source-to-artifact showcase in the README
4444
- Curate the example catalog into `simple`, `realistic`, and `advanced`
4545
- Polish diagnostics UX and `check` output
4646
- Add lightweight language evolution and compatibility notes
4747

48-
## Unreleased
48+
## v0.6 (Completed)
4949

50-
- Open the v0.5.0 adoption, editor, and polish milestone
51-
- Strengthen the repo front door and demo story
52-
- Improve example navigation and onboarding paths
53-
- Refine editor and diagnostics polish without widening the language core
50+
- **Mermaid Export Polish**: improve presentation and layout-friendliness
51+
- **Markdown Summary v2**: better multi-block support and deliberate layout
52+
- **HTML Documentation Export**: first static HTML doc output path
53+
- **Demos & Showcase Upgrade**: stronger source → artifact visual story
54+
- **Integration Contract Polish**: tighten and document exporter stability
55+
56+
## v0.7 (Planned)
57+
58+
Theme: **Packaging, Distribution, and Trust**
59+
60+
- **CLI Experience**: Globally installable via `npm install -g orgscript`.
61+
- **VS Code Extension Publication**: Marketplace readiness and metadata.
62+
- **Documentation Site**: Automated static documentation on GitHub Pages.
63+
- **Trust & Showcase**: Complex business logic scenarios and integration examples.
5464

5565
## Later
5666

docs/roadmaps/v0.7.0.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# OrgScript v0.7.0 Roadmap
2+
3+
Status: Planned
4+
Theme: **Packaging, Distribution, and Trust**
5+
6+
The goal of v0.7.0 is to transform OrgScript from a "cool repository" into a "professional tool" that is easy to install, use, and trust in real-world environments.
7+
8+
## Goals
9+
10+
- Establish a smooth installation path for the CLI.
11+
- Prepare the VS Code extension for potential marketplace publication.
12+
- Build a stable, hosted documentation facade using GitHub Pages.
13+
- Increase trust through high-quality showcase examples and integration patterns.
14+
15+
## Work Packages
16+
17+
### WP1: CLI Packaging & Installation
18+
- Refine `package.json` for global installation (`npm install -g orgscript`).
19+
- Ensure the binary works correctly when called from any directory.
20+
- Add `orgscript --version` and improved help text.
21+
22+
### WP2: VS Code Extension Readiness
23+
- Update `editors/vscode/package.json` with metadata, icon, and community links.
24+
- Review and refine the syntax grammar for any edge cases found in v0.6 examples.
25+
- Document the local installation/development flow for contributors.
26+
27+
### WP3: Documentation & GitHub Pages
28+
- Establish a "Docs Site" structure under `docs/site/`.
29+
- Automate the generation of the documentation site using the `export html` command.
30+
- Set up GitHub Actions to deploy to GitHub Pages on every push to `main`.
31+
32+
### WP4: Trust & Showcase Assets
33+
- Add "Complex logic" showcase: A realistic multi-department process (e.g. Hiring or Procurement).
34+
- Create a "Reference Architecture" showing how to integrate OrgScript results into a Python/Node.js backend.
35+
- Build a small "Integration Example" (e.g. a script that checks a JSON payload against OrgScript rules).
36+
37+
## Non-Goals
38+
- Adding major new language features.
39+
- Redesigning the core parser or semantic layer.
40+
- Building a full Web IDE (staying focused on local-first tools).

0 commit comments

Comments
 (0)