docs(scaffold): document hero_rpc#98 UI scaffolds + --no-web flag #279

Merged

timur merged 1 commit from issue-98-scaffold-docs into development

2026-05-21 00:00:13 +00:00

timur commented

2026-05-20 23:53:44 +00:00

Owner

Summary

Documents the new UI scaffolds shipped by hero_rpc#98:

Adds the --no-web flag to the CLI + library API tables (_web is default-on per #98).
Rewrites the layout block to show the per-binary file tree for the new _admin (templates + routes + state/error/templates Rust modules) and the new _web (read-only public sibling).
New section "UI scaffolds — out of the box" explains the per-root-object surface, the seven generated CRUD trait methods (<entity>_{new,get,set,delete,list,list_full,exists}), and the preserve-once semantics.
Trims the "Known gaps" list — the old gaps (Makefile / buildenv removal, missing examples crate, PURPOSE.md/README.md/Forgejo workflow, old _sdk deps, missing UI) are now all scaffolder-emitted across hero_rpc#54 + #90 + #98.

Doc-only change. No skill behavior modifications.

Test plan

Skim the rendered markdown on the PR diff view.
Verify the layout block matches the actual scaffolder output (cross-check against the regenerated example/recipe_server on hero_rpc#98's branch).

## Summary Documents the new UI scaffolds shipped by [hero_rpc#98](https://forge.ourworld.tf/lhumina_code/hero_rpc/issues/98): - Adds the `--no-web` flag to the CLI + library API tables (`_web` is default-on per #98). - Rewrites the layout block to show the per-binary file tree for the new `_admin` (templates + routes + state/error/templates Rust modules) and the new `_web` (read-only public sibling). - New section "UI scaffolds — out of the box" explains the per-root-object surface, the seven generated CRUD trait methods (`<entity>_{new,get,set,delete,list,list_full,exists}`), and the preserve-once semantics. - Trims the "Known gaps" list — the old gaps (Makefile / buildenv removal, missing examples crate, PURPOSE.md/README.md/Forgejo workflow, old `_sdk` deps, missing UI) are now all scaffolder-emitted across hero_rpc#54 + #90 + #98. Doc-only change. No skill behavior modifications. ## Test plan - [ ] Skim the rendered markdown on the PR diff view. - [ ] Verify the layout block matches the actual scaffolder output (cross-check against the regenerated `example/recipe_server` on hero_rpc#98's branch).

timur added 1 commit

2026-05-20 23:53:44 +00:00

docs(scaffold): document hero_rpc#98 UI scaffolds + --no-web flag ae5cef5797

Reflects the new scaffolder output landed in hero_rpc#98:

- `--no-web` flag documented in the CLI + library tables — `_web` is
  default-on.
- Layout block rewritten with the per-binary file tree:
  - `_admin` ships `templates/{base,index}.html` + per-entity
    `templates/<entity>/{list,detail,new}.html` + Rust modules
    (`state.rs`, `error.rs`, `templates.rs`, `routes/{mod,index,<entity>}.rs`)
    — all driving the typed SDK trait.
  - `_web` is the public read-only sibling; list + detail only, no
    create/delete affordances.
  - SDK output now consistently lives under `sdk/{rust,rhai,python,js}/`
    per hero_rpc#70.
- New "UI scaffolds — out of the box" section explains the per-root-
  object surface, the seven generated CRUD trait methods, and the
  preserve-once semantics.
- "Known gaps" trimmed — the old list (Makefile/buildenv.sh, missing
  examples / PURPOSE.md / README.md / Forgejo workflow, old `_sdk`
  Cargo deps, missing UI) is now all scaffolder-emitted across
  hero_rpc#54 / #90 / #98. Remaining gaps tightened to: custom service
  method handlers, claim/pattern rules in service.toml, custom CSS.