docs: restructure README for portfolio readability, add fork attribution - #77
Open
Sykezzz wants to merge 5 commits into
Open
docs: restructure README for portfolio readability, add fork attribution#77Sykezzz wants to merge 5 commits into
Sykezzz wants to merge 5 commits into
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This PR's README restructure correctly moved the "tested pin" line to docs/district-operations.md, but bump_gam.py's update_versioned_sources() still looked for that marker in README.md, causing the gam-compat (latest preview) check to fail with "Expected one version marker in README.md; found 0." Retarget the replacement to the file that now actually holds the marker.
…move Matches the previous commit's fix to scripts/bump_gam.py: the "tested pin" marker test fixture now lives in docs/district-operations.md instead of README.md, so this test asserts against the right file.
Now that bump_gam.py writes the tested-pin marker into docs/district-operations.md, the automated pin-bump workflow's git add list needs to include that file too, or future automated bump commits would silently drop the change to it.
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
1 participant
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.
Restructures the top-level README to lead with the fork's purpose, an About This Fork section, and proof points, matching the order a reviewer actually reads in. Moves the district change-control gate, live-verification matrix, and other deep operational detail into docs/change-control.md, docs/live-verification.md, and docs/district-operations.md, leaving short pointers in the README. Adds CI/CodeQL/upstream-sync/etc. status badges near the title. Adds MY-CONTRIBUTIONS.md (upstream baseline vs. what I built) and DEVELOPMENT-PROCESS.md (how AI-assisted changes are reviewed, tested, and authorized before touching a live tenant). No content was deleted, everything from the old README lives in one of the new docs files.