generation (#71) #76

Merged

timur merged 1 commit from issue-71-drop-docs-schemas into development

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

timur commented

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

Owner

Closes #71.

Removes the unused per-schema docs emission from the build pipeline and the scaffolder. The OpenRPC spec already covers the API surface for every SDK target, and the OSchema source itself is the canonical reference.

Summary

Drop docs_dir field + builder method on OschemaBuildConfig.
Delete crates/generator/src/build/emit/docs.rs and its mod docs; registration.
Remove docs_output_dir plumbing in OschemaBuilder::generate (incl. the reset-mode docs/schemas/{domain} cleanup branch and the generate_docs_index call).
Remove docs_base_dir parameter from generate_domain.
Scaffolder no longer creates docs/schemas/ or emits .docs_dir(...) in the per-crate build.rs template; updates layout/README templates.
Prunes docs/schemas references from repo READMEs, GETTING_STARTED, generator README, build README, and example/recipe_server/README.md.
Drops the now-stale example/recipe_server/docs/ and crates/server/examples/recipe_server/docs/ trees.
Hero_skills companion change: see https://forge.ourworld.tf/lhumina_code/hero_skills/pulls (branch issue-71-drop-docs-schemas-ref).

Verification

cargo check -p hero_rpc_generator — clean
cd example/recipe_server && cargo check -p hero_recipes — clean (only pre-existing unused-imports warning)
cargo test -p hero_rpc_generator --lib build:: — 31 passed
Fresh hero_rpc_generator --name hero_demo --workspace-dir … (with a seed .oschema) produces no docs/ directory ✅

Test plan

cargo check on generator and recipe_server
cargo test on the build module
Fresh scaffold produces no docs/schemas/
CI green on this branch

Closes #71. Removes the unused per-schema docs emission from the build pipeline and the scaffolder. The OpenRPC spec already covers the API surface for every SDK target, and the OSchema source itself is the canonical reference. ## Summary - Drop `docs_dir` field + builder method on `OschemaBuildConfig`. - Delete `crates/generator/src/build/emit/docs.rs` and its `mod docs;` registration. - Remove `docs_output_dir` plumbing in `OschemaBuilder::generate` (incl. the reset-mode `docs/schemas/{domain}` cleanup branch and the `generate_docs_index` call). - Remove `docs_base_dir` parameter from `generate_domain`. - Scaffolder no longer creates `docs/schemas/` or emits `.docs_dir(...)` in the per-crate `build.rs` template; updates layout/README templates. - Prunes `docs/schemas` references from repo READMEs, GETTING_STARTED, generator README, build README, and `example/recipe_server/README.md`. - Drops the now-stale `example/recipe_server/docs/` and `crates/server/examples/recipe_server/docs/` trees. - Hero_skills companion change: see https://forge.ourworld.tf/lhumina_code/hero_skills/pulls (branch `issue-71-drop-docs-schemas-ref`). ## Verification - `cargo check -p hero_rpc_generator` — clean - `cd example/recipe_server && cargo check -p hero_recipes` — clean (only pre-existing unused-imports warning) - `cargo test -p hero_rpc_generator --lib build::` — 31 passed - Fresh `hero_rpc_generator --name hero_demo --workspace-dir …` (with a seed `.oschema`) produces **no `docs/` directory** ✅ ## Test plan - [x] `cargo check` on generator and recipe_server - [x] `cargo test` on the build module - [x] Fresh scaffold produces no `docs/schemas/` - [ ] CI green on this branch

timur added 1 commit

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

Drop docs/schemas/ generation path (#71 )

Test / test (push) Failing after 2m51s

Details

Test / test (pull_request) Failing after 2m53s

Details

814cb8dd97

Remove the unused per-schema docs emission from the scaffolder and
build pipeline. The OpenRPC spec covers the API surface for every SDK
target; the OSchema source itself is the canonical reference.

- OschemaBuildConfig: drop docs_dir field + builder method, prune docs
  references from doc comments.
- OschemaBuilder: drop docs_output_dir, the docs/schemas/{domain}
  reset-mode cleanup branch, and the generate_docs_index call.
- emit/docs.rs deleted; emit/mod.rs no longer references it.
- emit/domain.rs: drop docs_base_dir parameter and the per-domain
  docs dir creation.
- Scaffolder: stop creating docs/schemas/, drop .docs_dir(...) from
  the generated build.rs template, prune layout/README references.
- README.md / GETTING_STARTED.md / generator README / build README /
  recipe_server README: prune docs/schemas references.
- example/recipe_server/build.rs and crates/server/examples/.../build.rs:
  drop .docs_dir(...) calls.
- Delete the now-stale generated example/recipe_server/docs/ and
  crates/server/examples/recipe_server/docs/ trees.

Verified: cargo check on the generator + recipe_server; cargo test on
the build module (31 passed); fresh `hero_rpc_generator --name …`
scaffold produces no docs/ directory.

Closes #71

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

timur referenced this pull request from lhumina_code/hero_skills

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

hero_service_scaffold: drop docs/schemas reference #267

timur referenced this pull request

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

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

timur merged commit e5ce683261 into development

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

timur referenced this pull request from a commit

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

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