Skip to content

docs: fix examples README, README TS imports, and init-template skills (schedule/npm/ruby/gha-404)#131

Merged
markovejnovic merged 1 commit into
mainfrom
relprep/6-docs-fix-readme-examples-skills
Jun 10, 2026
Merged

docs: fix examples README, README TS imports, and init-template skills (schedule/npm/ruby/gha-404)#131
markovejnovic merged 1 commit into
mainfrom
relprep/6-docs-fix-readme-examples-skills

Conversation

@markovejnovic

Copy link
Copy Markdown
Contributor

Summary

Fixes stale API-surface references in user- and agent-facing docs that the DSL evolution left behind. The published surface changed (npm/bun folded into a unified js toolchain, the Ruby toolchain removed, the schedule trigger + croniter dropped, the TS package renamed to @harmont/hm), but several docs and embedded hm init skill templates still advertised the old API. Agents and users following them hit AttributeErrors, unknown-arg errors, dead doc rows, and 404 fetches.

Changes (single commit, 5 files):

  • examples/README.mdhm.npm/hm.bun/hm.rubyhm.js.project(...) (bun → runtime="bun"); drop the deleted [ruby](./ruby) table row; replace the invalid hm run <slug> --local / hm run ci --local with hm run (local Docker is the default backend) plus a --backend cloud note.
  • README.md — TypeScript quickstart imports harmont / harmont/toolchains@harmont/hm / @harmont/hm/toolchains (the published name). Python example left as-is (the PyPI package is still harmont).
  • skill_write_pipeline.md + committed .claude/skills/write-pipeline/SKILL.md — drop the removed schedule trigger from the triggers guidance; npmjs in the toolchain list; remove stale Ruby references so the committed dogfood copy byte-matches the embedded template.
  • skill_convert_gha.mdon: schedule now maps to "No local DSL trigger" (a Harmont Cloud concern) instead of a bogus "Direct mapping"; add schedule to the real-gaps list; hm.npmhm.js in the setup-* mapping; remove the dead WebFetch of the 404 docs.harmont.dev/examples/github-actions.md.

Findings addressed

  • examples-readme-dead-toolchain-calls-1
  • examples-readme-local-flag-1
  • ts-pkg-rename-readme-1
  • skills-schedule-removed-1
  • skills-npm-toolchain-1
  • claude-skill-ruby-stale-1
  • skills-gha-example-404-1

Verification evidence

Claims in the edited docs were checked against the current code in the branch:

  • hm.js.project(...) exists and accepts runtime
    grep -n "def project" crates/hm-dsl-engine/harmont-py/harmont/_js.py233: def project( with runtime: Runtime | None = None.
  • runtime="bun" is valid →
    _js.py:38 Runtime = Literal["node", "bun", "deno"].
  • Ruby toolchain removed →
    ls crates/hm-dsl-engine/harmont-py/harmont/_ruby.pyNo such file or directory.
  • schedule trigger removed →
    grep -in "schedule" crates/hm-dsl-engine/harmont-py/harmont/triggers.py → no matches.
  • TS package renamed →
    crates/hm-dsl-engine/harmont-ts/package.json:2 "name": "@harmont/hm".
  • --backend cloud flag exists (and --local is gone, so the old hm run ... --local is correctly replaced) →
    crates/hm/src/cli/run.rs:59 pub backend: Option<String>, docstring docker (default) ... cloud submits it to Harmont Cloud.
  • Committed dogfood skill byte-matches the embedded template →
    diff crates/hm/src/commands/init_templates/skill_write_pipeline.md .claude/skills/write-pipeline/SKILL.md → IDENTICAL.

Docs-only change to Markdown files; no Rust/Python/TS source touched, so no compile/test impact.

Judge verdict

Approved. No blocking issues. Implementer verification passed.


Generated by the Harmont release-readiness workflow (automated; needs human review before merge). 🤖

…skills

The DSL evolved (bun/npm folded into the unified `js` toolchain, Ruby
toolchain removed, schedule trigger + croniter dropped, TS package renamed
to @harmont/hm), but several docs and embedded skill templates still
advertised the old API surface. Agents and users following them hit
AttributeErrors, unknown-arg errors, dead URLs, and 404 fetches.

- examples/README.md: `hm.npm`/`hm.bun`/`hm.ruby` -> `hm.js.project(...)`
  (bun: `runtime="bun"`); drop the deleted `[ruby](./ruby)` row; replace
  the invalid `hm run <slug> --local` / `hm run ci --local` with `hm run`
  (local Docker is the default backend) plus a `--backend cloud` note.
  (examples-readme-dead-toolchain-calls-1, examples-readme-local-flag-1)
- README.md: TypeScript quickstart imports `harmont` / `harmont/toolchains`
  -> `@harmont/hm` / `@harmont/hm/toolchains` (the published name). Python
  example left as-is (PyPI package is still `harmont`).
  (ts-pkg-rename-readme-1)
- skill_write_pipeline.md + committed .claude/skills/write-pipeline/SKILL.md:
  drop the removed `schedule` trigger from the triggers guidance; `npm` ->
  `js` in the toolchain list; remove stale Ruby references from the
  committed dogfood copy so it byte-matches the embedded template.
  (skills-schedule-removed-1, skills-npm-toolchain-1, claude-skill-ruby-stale-1)
- skill_convert_gha.md: `on: schedule` now maps to "No local DSL trigger"
  (a Harmont Cloud concern) instead of a bogus "Direct mapping"; soften the
  inventory note and add schedule to the real-gaps list; `hm.npm` -> `hm.js`
  in the setup-* mapping; remove the dead WebFetch of the 404
  docs.harmont.dev/examples/github-actions.md.
  (skills-schedule-removed-1, skills-npm-toolchain-1, skills-gha-example-404-1)
@markovejnovic markovejnovic merged commit 80b729e into main Jun 10, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant