This repository is the dedicated Bridgetown source for
https://solverforge.github.io/.
src/docs/**for public product docs and tutorialssrc/reference/**for dense engineering reference and clearly labeled maintainer notessrc/_posts/**for blog and release postsfrontend/**for bundled CSS/JS sourcesplugins/**for build-time extensions, including static search generation
This repo owns the published website. It does not replace repo-local engineering surfaces in the product repositories.
SolverForge/solverforgekeeps the Rust workspaceREADME.mdandcrates/*/WIREFRAME.mdfiles.SolverForge/solverforge-cli,SolverForge/solverforge-ui, andSolverForge/solverforge-mapskeep their own repo-local maintainer files, architecture notes, and implementation detail.- This site should summarize and integrate those surfaces where useful, but it should not mirror them wholesale.
When a source repo changes public APIs, naming, onboarding, or maintainer workflow, update the matching published pages here in the same effort.
Preferred entry points:
make helpmake installmake ci-localmake pre-releasemake start
Direct Bridgetown commands:
bundle installnpm cibundle exec rake frontend:buildbundle exec bridgetown buildruby scripts/verify-cli-release.rbruby scripts/verify-hospital-tutorial.rbruby scripts/verify-deliveries-tutorial.rbbundle exec bridgetown start -P 4017
make verify-hospital-tutorial always runs site-local copy and snippet checks.
When SOLVERFORGE_CLI_REPO or SOLVERFORGE_HOSPITAL_REPO point to local
product checkouts, it also runs the CLI scaffold and live hospital app checks.
The Make target is the stable public workflow; the Ruby script is an
implementation detail behind that target.
make verify-deliveries-tutorial follows the same pattern for
solverforge-deliveries. It always checks the published guide and dependency
snippets, then adds source-level and live app checks when
SOLVERFORGE_DELIVERIES_REPO points to the app checkout.
make ci-local runs the same path as GitHub Actions: toolchain checks, syntax
linting, a full Bridgetown build, and the portable tutorial verifiers.
make pre-release first installs the published solverforge-cli release into
/tmp, verifies the scaffold targets, and then delegates to the local CI gate.
The current make lint target is dependency-light and only performs Ruby and
JavaScript syntax checks with the existing toolchain. A stricter follow-up
should add configured tooling before broadening the gate:
- Ruby: StandardRB or RuboCop, chosen once the repo style is settled
- JavaScript/CSS: ESLint plus Prettier
- Markdown/content: markdownlint and an internal link checker
After those tools are configured, extend fmt, fmt-check, and lint to use
them instead of relying only on syntax checks.
This repo is meant to be served directly as the GitHub Pages source for
solverforge.github.io. GitHub Actions installs dependencies with
make install, runs make ci-local, and deploys output/ to Pages.