[codex] Improve agent onboarding docs#1652
Draft
arjxnt wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR makes the Jolt onboarding path for humans and AI coding agents match the current
jolt newscaffold and adds CI coverage so it stays that way.Changes:
src/main.rspreprocess_verifier_*(_, _, blindfold_setup)APIscripts/ci/check_docs_scaffold.pyto check quickstart/scaffold drift, SUMMARY links, README linkage, and expected agent-workflow sectionsWhy
The book examples had drifted from what
jolt newcurrently emits. In particular, the quickstart omittedpreprocess_shared_*().unwrap(), omitted the third verifier preprocessing argument, and placed#![no_main]in the library snippet even though the generated scaffold keeps that inguest/src/main.rs.That is exactly the first-run friction new contributors and coding agents hit. The new checker makes that drift visible in CI without requiring a full Rust workspace compile.
Validation
Local:
python -m py_compile scripts/ci/check_docs_scaffold.pypassedpython scripts/ci/check_docs_scaffold.pypassed using the Codex bundled Python runtimegit diff --check HEADpassedGitHub:
DocsandBuild and Test Joltwere enqueued but are currentlyaction_requiredbefore any jobs start, which appears to require maintainer approval for forked PR Actions/new workflow executionNot run locally:
mdbook build ./book; this Windows environment does not have a working Rust linker/binutils setup for installing mdbook plugins locallylink.exe, and GNU failed due missingdlltool.exeon this machine