Repository navigation
docs(docs): Add a quickstart and the example files it copies - #27
Merged
Merged
Conversation
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
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.
What changed
docs/QUICKSTART.mdwalks through setting up a strength match in an engine's own repository. It covers: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 guidestrength.yml, a match run by handsprt.yml, a sequential test run by hand and carried across runs withprior_pairstests/test_examples.pychecks the examples and the guide:strength.ymltakes at that tag, and none it requires is left outbatch.ymlpasses, 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.mdsaidgit archivestamps files at extraction time by default. It records the commit's time, andtar -mis what stamps them at extraction. I checked this with a real extract.The call in
.github/workflows/README.mdnamedv0.3.0and now namesv0.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