docs: clean up + regenerate to match the multi-domain API (#138) #147

Merged

mahmoud merged 1 commit from development_docs_138 into development

2026-06-09 11:50:08 +00:00

mahmoud commented

2026-06-09 11:06:58 +00:00

Owner

Docs cleanup — match the multi-domain + typed-inputs API (#138)

Follow-up to the code cleanup in #144. Brings the docs in line with the current API.

Regenerated api.md from the openrpc specs: 1029 -> 196 lines, 118 methods across the 4 domains (jobs/logs/secrets/system), correct 0.6/0.7 versions. Drops the pre-multi-domain "OUTDATED" banner, ServiceConfig, and the v0.5.0 / "93 methods" drift. Source of truth is now the specs; this is a generated index.
Corrected overview.md + sdk_examples.md — both claimed typed inputs were "all removed"/"historical"; #140 restored them (job_create/run_quick_submit with an inputs map, {{var}} templating, HERO_INPUT_* injection, declarative input_schema).
Removed stale/orphaned docs: MIGRATION_REMAP.md (the migration is complete + it had a wrong job_create line), .hero/build_report.md, docs/superpowers/* (completed plans), a stray memory file.

Known remaining (separate follow-up): ~30 ServiceConfig references across builders.md/database.md/sdk.md/service_specs.md/overview.md body need context-aware rewrites to ServiceSpec.

Refs #138

## Docs cleanup — match the multi-domain + typed-inputs API (#138) Follow-up to the code cleanup in #144. Brings the docs in line with the current API. - **Regenerated `api.md`** from the openrpc specs: **1029 -> 196 lines**, **118 methods** across the 4 domains (jobs/logs/secrets/system), correct 0.6/0.7 versions. Drops the pre-multi-domain "OUTDATED" banner, `ServiceConfig`, and the v0.5.0 / "93 methods" drift. Source of truth is now the specs; this is a generated index. - **Corrected `overview.md` + `sdk_examples.md`** — both claimed typed inputs were "all removed"/"historical"; #140 **restored** them (`job_create`/`run_quick_submit` with an `inputs` map, `{{var}}` templating, `HERO_INPUT_*` injection, declarative `input_schema`). - **Removed stale/orphaned docs**: `MIGRATION_REMAP.md` (the migration is complete + it had a wrong `job_create` line), `.hero/build_report.md`, `docs/superpowers/*` (completed plans), a stray memory file. Known remaining (separate follow-up): ~30 `ServiceConfig` references across `builders.md`/`database.md`/`sdk.md`/`service_specs.md`/`overview.md` body need context-aware rewrites to `ServiceSpec`. Refs #138

mahmoud added 1 commit

2026-06-09 11:06:58 +00:00

docs: clean up + regenerate to match the multi-domain API

Build and Test / build (pull_request) Successful in 18m32s

Details

04ac4345e1

- Regenerate api.md from the openrpc specs (1029->196 lines, 118 methods,
  4 domains); drop the pre-multi-domain OUTDATED banner, ServiceConfig, v0.5.0 drift
- Correct overview.md + sdk_examples.md typed-inputs notes: inputs were RESTORED
  in #140 (job_create/run_quick_submit + {{var}} + HERO_INPUT_* + input_schema)
- Remove stale/orphaned docs: MIGRATION_REMAP.md, .hero/build_report.md,
  docs/superpowers/*, a stray memory file

Refs #138