Skip to content

docs(docs): Add a quickstart and the example files it copies - #27

Merged
aywrite merged 1 commit into
mainfrom
claude/stoic-ramanujan-xqxekr
Sep 29, 2026
Merged

aywrite merged 1 commit into
mainfrom
claude/stoic-ramanujan-xqxekr

Conversation

@aywrite

@aywrite aywrite commented Sep 29, 2026 •

Copy link
Copy Markdown
Owner

What changed

  • docs/QUICKSTART.md walks through setting up a strength match in an engine's own repository. It covers:

    • the build script
    • the workflow
    • a first run
    • a sequential test carried across runs
    • testing a pull request

    It ends with the errors a first run is likely to hit and a table of the common inputs. The README links to it from the opening section.

  • examples/ holds the files the guide copies until there is an example repository:

    • build_at.sh, written for cargo, with make and cmake versions of its two build lines given in the guide
    • strength.yml, a match run by hand
    • sprt.yml, a sequential test run by hand and carried across runs with prior_pairs
  • tests/test_examples.py checks the examples and the guide:

    • every call and every version the guide names is the current release
    • every input the examples pass is one that strength.yml takes at that tag, and none it requires is left out
    • the guide's copy of the example workflow matches the file
    • the build script is executable in git
    • run against a stub cargo, with the relative path batch.yml passes, the build script builds the commit it is given and leaves the working tree alone. It also checks that the export is stamped at extraction time, not with the commit's time.
  • docs/BUILDING-A-REF.md said git archive stamps files at extraction time by default. It records the commit's time, and tar -m is what stamps them at extraction. I checked this with a real extract.

  • The call in .github/workflows/README.md named v0.3.0 and now names v0.6.0.

  • AGENTS.md says the examples move with the self pins on a release branch.

🤖 Generated with Claude Code

https://claude.ai/code/session_018ccJFsmZ4jAKYmFNgNBh9u


Generated by Claude Code

docs/QUICKSTART.md walks through setting up a strength match in an
engine's own repository. It covers the build script, the workflow, a
first run, a sequential test carried across runs and testing a pull
request. It ends with the errors a first run is likely to hit and a
table of the common inputs.

The files it copies are in examples/ until there is an example
repository: a build script written for cargo and two caller workflows.

tests/test_examples.py holds them to the release this tree is and to
the inputs the pinned strength.yml takes. It checks that the guide's
copy of the example workflow matches the file. It also runs the build
script against a stub cargo, with the relative path batch.yml passes,
to check that it builds the commit it is given from an export stamped
at extraction time.

docs/BUILDING-A-REF.md said git archive stamps files at extraction time
by default. It records the commit's time, and tar -m is what stamps
them at extraction. The call in .github/workflows/README.md named
v0.3.0 and now names the current release. AGENTS.md says the examples
move with the self pins on a release branch.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018ccJFsmZ4jAKYmFNgNBh9u
@aywrite
aywrite merged commit 5a8b9aa into main Sep 29, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants