Replace The Jeff Paradox README with JeffEngine ABI/FFI docs - #2
Conversation
- Delete thejeffparadox_README.md (generic copy-paste artifact that
incorrectly described the project as "decision theory analysis")
- Replace all {{PROJECT}}/{{project}}/{{LICENSE}} placeholders in
ABI-FFI-README.md with JeffEngine/jeff_engine/MPL-2.0-or-later
- Fix Project.toml: remove non-standard [project] header, bump
julia compat from 1.9 to 1.10 (matches CI), add [extras]/[targets]
for Test dependency
- Make ShellCheck a hard CI failure (remove continue-on-error)
https://claude.ai/code/session_01DR54srjfuMGcdAmo5LZFPT
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: adfd9ea3bf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ┌─────────────────────────────────────────────┐ | ||
| │ C Headers (auto-generated) │ | ||
| │ generated/abi/{{project}}.h │ | ||
| │ generated/abi/jeff_engine.h │ |
There was a problem hiding this comment.
This documentation now states that the generated header and library are named jeff_engine (for example generated/abi/jeff_engine.h), but the actual Zig build config still emits {{project}} placeholders for both library and header names (ffi/zig/build.zig lines 12, 23, 35-36). In its current state, users following these instructions will try to include/link files that do not match what the build produces, so the FFI integration steps are likely to fail until docs and build outputs are synchronized.
Useful? React with 👍 / 👎.
Description
This PR removes the outdated "The Jeff Paradox" project README and updates the ABI/FFI documentation to be specific to the JeffEngine project. It also includes configuration updates to the Julia project manifest and CI/CD pipeline.
Type of Change
Changes Made
thejeffparadox_README.md(outdated project documentation)ABI-FFI-README.mdto replace template placeholders with JeffEngine-specific content:{{PROJECT}}/{{project}}toJeffEngine/jeff_engine{{LICENSE}}toMPL-2.0-or-laterengine/Project.toml:[project]section header (not standard Julia format)1.9to1.10[extras]and[targets]sections for test dependencies.github/workflows/ci.yml:continue-on-error: truefrom ShellCheck step to enforce stricter lintingTesting
No testing needed - these are documentation and configuration updates with no functional code changes. CI/CD pipeline changes will be validated by the workflow execution.
Checklist
General
Documentation
CI/CD
Additional Notes
The removal of the "The Jeff Paradox" README suggests a pivot in project focus toward the JeffEngine implementation. The ABI/FFI documentation is now properly configured for the actual project being developed.
https://claude.ai/code/session_01DR54srjfuMGcdAmo5LZFPT