Polish documentation and release validation for public launch - #1
Merged
Conversation
icerain-cmd
marked this pull request as ready for review
July 22, 2026 10:11
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
validateworkflow to run all three validators andmkdocs build --strictWhy
The public repository passed its original Linux checks but was not reproducible from a normal Windows checkout. Default encoding caused two validators to stop, CRLF conversion invalidated every manifest checksum, and
site/docs/DIFFERENCES.mdcollided withsite/docs/differences.md. Public documentation also did not consistently distinguish tested agent harnesses from unverified installation guidance.User and maintainer impact
New users now get complete project-local layouts, file-count checks, a nested-installation warning, a minimal first prompt, and a read-only pilot structure. Maintainers get cross-platform validation, path-case checks, deterministic manifest regeneration, and one protected CI check covering repository, integration, public-release, and MkDocs validation.
Cursor loading remains explicitly unverified because Cursor is not installed in the audit environment. The existing
v1.0.0tag and Release are unchanged; these fixes are suitable for a subsequentv1.0.1patch.Validation
python scripts/validate_repository.py— PASSpython scripts/run_integrated_tests.py— PASSpython scripts/validate_public_release.py— PASSmkdocs build --strict— PASS usingsite/requirements.txtgit diff --check— PASSgit fsck --no-reflogs --full— PASS