You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: make the documented install path real (Justfile recipes, quickst… (#34)
…arts, smoke CI)
PR 4 of 8 in the severity-ordered RCA chain (P0-docs): the primary
user-facing install docs drove `just` recipes that were template stubs,
so a new user following any quickstart could not install or run the
software. This makes the documented path real and adds CI so it cannot
silently rot.
- Justfile: implement setup (Pkg.instantiate), deps (alias of setup),
build/build-release (Pkg.precompile), run/run-verbose (main()); add a
julia check to doctor; fix an invalid `//` comment on line 2 that made
modern `just` fail to parse the file at all
- QUICKSTART-USER.adoc: replace template placeholders with a real
minimal quickstart; expected output now matches what main() actually
prints (banner + LM Studio fallback to offline examples); drop
references to nonexistent stapeln-run/install/uninstall recipes
- QUICKSTART-DEV.adoc: replace
{{LANG_STACK}}/{{BUILD_CMD}}/{{TEST_CMD}}/ {{MUST_INVARIANTS}} with real
Julia commands and invariants; fix setup-dev -> setup, tests/ -> test/,
Mustfile path; drop panic-scan/ llm-context/flake.nix references
- QUICKSTART-MAINTAINER.adoc: trim to flows that work (build-release,
doctor, load check, test); mark Containerfile/guix.scm as not yet
functional; document the real env-var configuration
- docs/QUICKSTART.md: was cloning a different repo (rsr-template-repo);
reduced to a pointer at the canonical quickstarts
- .tool-versions: pin julia 1.10.11 (same minor as e2e.yml CI)
- README.adoc: correct module count 17 -> 40 (src/stats/*.jl)
- .github/workflows/install-smoke.yml: NEW smoke job running `just setup
&& julia --project=. -e 'using Statistikles' && just --list` on
ubuntu-latest with SHA-pinned checkout/setup-julia/cache/setup-just;
step-level guards only (no job-level hashFiles/secrets conditionals)
Verified locally (WSL Debian, Julia 1.10.11, just 1.56.0): just --list
parses; every recipe referenced by any quickstart exists; just setup,
package load, just run (offline fallback), just doctor all pass.
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
## Summary
<!-- Briefly describe what this PR does and why. Link to related issues
with "Closes #N". -->
## Changes
<!-- List the key changes introduced by this PR. -->
-
## RSR Quality Checklist
<!-- Check all that apply. PRs that fail required checks will not be
merged. -->
### Required
- [ ] Tests pass (`just test` or equivalent)
- [ ] Code is formatted (`just fmt` or equivalent)
- [ ] Linter is clean (no new warnings or errors)
- [ ] No banned language patterns (no TypeScript, no npm/bun, no
Go/Python)
- [ ] No `unsafe` blocks without `// SAFETY:` comments
- [ ] No banned functions (`believe_me`, `unsafeCoerce`, `Obj.magic`,
`Admitted`, `sorry`)
- [ ] SPDX license headers present on all new/modified source files
- [ ] No secrets, credentials, or `.env` files included
### As Applicable
- [ ] `.machine_readable/STATE.a2ml` updated (if project state changed)
- [ ] `.machine_readable/ECOSYSTEM.a2ml` updated (if integrations
changed)
- [ ] `.machine_readable/META.a2ml` updated (if architectural decisions
changed)
- [ ] Documentation updated for user-facing changes
- [ ] `TOPOLOGY.md` updated (if architecture changed)
- [ ] `CHANGELOG` or release notes updated
- [ ] New dependencies reviewed for license compatibility (MPL-2.0 /
MPL-2.0)
- [ ] ABI/FFI changes validated (`src/abi/` and `ffi/zig/` consistent)
## Testing
<!-- Describe how you tested these changes. -->
## Screenshots
<!-- If applicable, add screenshots or terminal output demonstrating the
change. -->
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
0 commit comments