Fold in round-2 public-readiness nice-to-haves - #103
Merged
Conversation
…ity, test comment - README.md: use ln -sf for the Installation symlink, matching Step 5's own registration convention (create-dev-loop.md:624). - CLAUDE.md: clarify that the ISSUE_TEMPLATE doc-table row's *.md glob deliberately excludes config.yml, which has no restatable conventions. - tests/test_check_docs.py: note in the module docstring that any new test class must reset check_docs.errors in its own setUp(), so a future addition doesn't silently leak state between tests. Not included, with reasons: - RESEARCH.md's "Observed effect: pending — needs N cycles of data" entries (PRs #29/#30/#52/#54): this needs real usage data the maintainer would have to supply; nothing to mechanically edit here without fabricating an observed effect. - The flagged openai.com RESEARCH.md link: re-verified via an independent fetch, still 403 (not 404) — consistent with bot/WAF blocking a non-browser client, not a confirmed dead link. Left as-is.
dmccoystephenson
added a commit
that referenced
this pull request
Aug 3, 2026
…ity, test comment (#103) - README.md: use ln -sf for the Installation symlink, matching Step 5's own registration convention (create-dev-loop.md:624). - CLAUDE.md: clarify that the ISSUE_TEMPLATE doc-table row's *.md glob deliberately excludes config.yml, which has no restatable conventions. - tests/test_check_docs.py: note in the module docstring that any new test class must reset check_docs.errors in its own setUp(), so a future addition doesn't silently leak state between tests. Not included, with reasons: - RESEARCH.md's "Observed effect: pending — needs N cycles of data" entries (PRs #29/#30/#52/#54): this needs real usage data the maintainer would have to supply; nothing to mechanically edit here without fabricating an observed effect. - The flagged openai.com RESEARCH.md link: re-verified via an independent fetch, still 403 (not 404) — consistent with bot/WAF blocking a non-browser client, not a confirmed dead link. Left as-is.
8 tasks
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
Addresses the remaining actionable nice-to-haves from the round-2 public-readiness re-review (post-merge of #102), plus cleans up the last 4 stale, already-merged branches.
README.md: Installation symlink now usesln -sf, matching Step 5's own registration convention (create-dev-loop.md:624) instead of the plainln -sit shipped with in Document install step; add ISSUE_TEMPLATE to doc sources table #102.CLAUDE.md: clarifies the ISSUE_TEMPLATE doc-table row — the*.mdglob deliberately excludesconfig.yml, which has no restatable conventions.tests/test_check_docs.py: module docstring now notes that any new test class must resetcheck_docs.errorsin its ownsetUp(), so a future addition doesn't silently leak state between tests.feature/add-research-md,feature/localization-and-command-sub-fixes,feature/rubric-based-self-review,license-mit) — all confirmedMERGEDviagh pr list --state all --head <branch>before deletion. (7 of the original 11 flagged in round 1 had already been cleaned up by the time of this review.)Not included, with reasons (both re-verified independently rather than assumed from the review):
openai.comRESEARCH.md link — re-fetched independently, still returns 403 (not 404), consistent with bot/WAF blocking a non-browser client rather than a genuinely dead link. Left as-is; worth a manual browser check if you want to be certain.Note: this repo's canonical location is now
Stephenson-Software/create-dev-loop(transferred since round 1's review, which still referenceddmccoystephenson/create-dev-loop) — this PR and the branch deletions above target the canonical org.Test plan
python3 scripts/check_docs.pypasses.python3 -m unittest discover -s tests -v— 13/13 pass.MERGEDviagh pr list --state all --head <branch>before deleting.🤖 Generated with Claude Code