Skip to content

Commit 241014c

Browse files
committed
docs: align wireframe with neutral scaffold surface
Update the CLI wireframe to describe the repo that actually ships today instead of the removed starter-family model. Document the single neutral-shell scaffold path, the retained /jobs contract, the generated solverforge.app.toml and ui-model outputs, and the fact that default_template remains only as a legacy rc parser field rather than a public scaffold selector. Verification: - audited WIREFRAME.md against src/commands/new.rs, src/rc.rs, and current scaffold tests
1 parent 5597c33 commit 241014c

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

WIREFRAME.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
## Scaffolding Surface
44

5-
The standalone CLI ships two built-in scaffold families only:
5+
The standalone CLI currently ships one built-in scaffold path only:
66

7-
- `solverforge new <name> --standard`
8-
- `solverforge new <name> --list`
7+
- `solverforge new <name>`
98

109
Domain-specific examples such as employee scheduling and vehicle routing are intentionally out of scope for the built-in scaffold catalog. They belong in quickstarts.
1110

11+
That built-in scaffold is a neutral shell. Users shape it afterward through facts, entities, variables, constraints, generated data, and `solverforge.app.toml` instead of selecting a starter family up front.
12+
1213
## Frontend Rule
1314

1415
For any generated frontend feature, ask first: does `solverforge-ui` already provide it?
@@ -25,12 +26,14 @@ The scaffold may still own thin composition code for domain-specific projections
2526

2627
## Generated Project Shape
2728

28-
Both built-in scaffold families should generate:
29+
The built-in neutral scaffold should generate:
2930

3031
- `Cargo.toml` with published `solverforge` and `solverforge-ui` dependencies
31-
- `src/api/` exposing the REST/SSE contract expected by `solverforge-ui`
32+
- `solverforge.app.toml` as the scaffolded app/domain contract
33+
- `src/api/` exposing the retained `/jobs` REST/SSE contract expected by `solverforge-ui`
3234
- `static/index.html` loading `/sf/sf.css` and `/sf/sf.js`
3335
- `static/app.js` containing only app composition and view-specific rendering
36+
- `static/generated/ui-model.json` as the compiler-owned view/model projection
3437
- `static/sf-config.json` as the preserved customization seam
3538

3639
## `sf-config.json`
@@ -44,7 +47,6 @@ The CLI may extend the config only for scaffold-owned rendering concerns. It sho
4447

4548
## RC Defaults
4649

47-
`default_template` values should align with the problem-type surface:
50+
`.solverforgerc` still carries a legacy `default_template` field in the parser for compatibility with older configs and tests, but it is not part of the current public scaffold surface and does not define multiple starter families today.
4851

49-
- `"standard"`
50-
- `"list"`
52+
Do not extend docs or new features around `default_template` unless the public scaffold model changes again.

0 commit comments

Comments
 (0)