Drop `docs/schemas/` generation — no per-schema docs needed #71

New issue

Closed

opened 2026-05-19 16:46:59 +00:00 by timur · 1 comment

timur commented

2026-05-19 16:46:59 +00:00

Owner

Problem

The scaffolder generates a docs/schemas/ directory with per-schema documentation. No one consumes it; the OpenRPC spec serves that purpose for all SDK targets, and the OSchema source itself is the canonical reference.

What to do

Remove docs/schemas/ generation from the scaffolder and the generator.
Drop the docs_dir setting on OschemaBuildConfig (or keep it opt-in with default disabled).
Remove the now-dead doc emission code path.
Update hero_service_scaffold.md to remove the docs/schemas/ reference.

Acceptance

Fresh scaffold produces no docs/schemas/ directory.
Existing schemas in recipe_server and hero_service continue to build (regenerate as needed).

## Problem The scaffolder generates a `docs/schemas/` directory with per-schema documentation. No one consumes it; the OpenRPC spec serves that purpose for all SDK targets, and the OSchema source itself is the canonical reference. ## What to do - Remove `docs/schemas/` generation from the scaffolder and the generator. - Drop the `docs_dir` setting on `OschemaBuildConfig` (or keep it opt-in with default disabled). - Remove the now-dead doc emission code path. - Update `hero_service_scaffold.md` to remove the `docs/schemas/` reference. ## Acceptance - Fresh scaffold produces no `docs/schemas/` directory. - Existing schemas in `recipe_server` and `hero_service` continue to build (regenerate as needed).

timur referenced this issue from a commit

2026-05-19 17:10:11 +00:00

Drop docs/schemas/ generation path (#71)

timur referenced this issue from a pull request that will close it,

2026-05-19 17:12:17 +00:00

Drop docs/schemas/ generation (#71) #76

timur commented

2026-05-19 17:12:35 +00:00

Author

Owner

PR up: #76

Companion change in hero_skills (removes docs/schemas/ from hero_service_scaffold.md layout): lhumina_code/hero_skills#267

Acceptance verified:

OschemaBuildConfig.docs_dir removed, emit/docs.rs deleted, no docs/schemas/ plumbing left in builder.rs / emit/domain.rs.
Scaffolder no longer creates docs/schemas/ or emits .docs_dir(...).
Recipe_server (in-tree example) and the smaller crates/server/examples/recipe_server/ both continue to cargo check cleanly with their .docs_dir(...) lines dropped; their stale docs/ trees are removed.
cargo test -p hero_rpc_generator --lib build:: — 31 passed.
Fresh hero_rpc_generator --name hero_demo … with one seed schema produces no docs/ directory.

PR up: https://forge.ourworld.tf/lhumina_code/hero_rpc/pulls/76 Companion change in hero_skills (removes `docs/schemas/` from `hero_service_scaffold.md` layout): https://forge.ourworld.tf/lhumina_code/hero_skills/pulls/267 Acceptance verified: - `OschemaBuildConfig.docs_dir` removed, `emit/docs.rs` deleted, no `docs/schemas/` plumbing left in builder.rs / emit/domain.rs. - Scaffolder no longer creates `docs/schemas/` or emits `.docs_dir(...)`. - Recipe_server (in-tree example) and the smaller `crates/server/examples/recipe_server/` both continue to `cargo check` cleanly with their `.docs_dir(...)` lines dropped; their stale `docs/` trees are removed. - `cargo test -p hero_rpc_generator --lib build::` — 31 passed. - Fresh `hero_rpc_generator --name hero_demo …` with one seed schema produces **no `docs/` directory**.

timur closed this issue

2026-05-19 23:42:50 +00:00

timur referenced this issue from a commit

2026-05-19 23:42:51 +00:00

Drop docs/schemas/ generation (#71) (#76)

timur referenced this issue

2026-05-20 00:12:36 +00:00

Move catalog/openrpc.json out of src/ to a top-level spec location #73

timur referenced this issue from lhumina_code/hero_skills

2026-05-20 00:15:53 +00:00

[META] Standardize Hero service architecture — template, hero_rpc alignment, framework hoist, skills #262