SolverForge
Search docs Ctrl K

Reference

Maintainer reference for ownership checks across SolverForge crates, docs, and companion libraries.

Maintainer Coordination Reference

Documentation ownership

Source Audience Role
Public SolverForge docs users, engineers, maintainers tutorials, concepts, references, releases, and integration guidance
SolverForge/solverforge repo files product maintainers core Rust workspace source of truth, including README.md and crates/*/WIREFRAME.md
SolverForge/solverforge-cli, SolverForge/solverforge-ui, SolverForge/solverforge-maps repo files product maintainers canonical repo-local onboarding, architecture, and implementation detail for those products

Product repositories remain canonical for source-level maintainer detail and should be referenced, not copied wholesale.

Canonical update rules

If you change… Update…
public docs, navigation, reference, or release content the matching public documentation pages
public API or onboarding in a product repo the product repo’s own README.md, wireframes, and implementation docs, plus the matching public documentation
repo-local maintainer workflow or architecture notes in a product repo the source repo first, then any public maintainer note that summarizes or points to that guidance

Repo-local maintainer material

The product repositories keep files that should remain repo-local:

  • SolverForge/solverforge: README.md, crates/*/WIREFRAME.md
  • SolverForge/solverforge-cli: repo-local maintainer docs and implementation notes
  • SolverForge/solverforge-ui: repo-local maintainer docs and implementation notes
  • SolverForge/solverforge-maps: repo-local maintainer docs and implementation notes

Those files are source-level maintainer material. Mention them when helpful, but do not duplicate their full contents here.

Routine maintainer checks

  • in this repo: make ci-local
  • before release or publishing: make pre-release
  • while editing locally: make help, make install, make build, and make start
  • in a product repo: run that repo’s own build, test, and release checks there

make verify-hospital-tutorial and make verify-deliveries-tutorial run documentation checks without product checkouts. Set SOLVERFORGE_CLI_REPO or SOLVERFORGE_HOSPITAL_REPO to add the deeper CLI scaffold and live hospital app checks. Set SOLVERFORGE_DELIVERIES_REPO to add deliveries source checks and the straight-line retained-job smoke against the local deliveries app. The Make targets are the stable workflow entry points; the verifier implementations are Ruby.

See also