Skip to content

Fold in round-2 public-readiness nice-to-haves - #103

Merged
dmccoystephenson merged 1 commit into
mainfrom
fix/readiness-round2-followups
Aug 3, 2026
Merged

Fold in round-2 public-readiness nice-to-haves#103
dmccoystephenson merged 1 commit into
mainfrom
fix/readiness-round2-followups

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

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 uses ln -sf, matching Step 5's own registration convention (create-dev-loop.md:624) instead of the plain ln -s it shipped with in Document install step; add ISSUE_TEMPLATE to doc sources table #102.
  • CLAUDE.md: clarifies the ISSUE_TEMPLATE doc-table row — the *.md glob deliberately excludes config.yml, which has no restatable conventions.
  • tests/test_check_docs.py: module docstring now notes 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.
  • Deleted the last 4 stale, already-squash-merged branches (feature/add-research-md, feature/localization-and-command-sub-fixes, feature/rubric-based-self-review, license-mit) — all confirmed MERGED via gh 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):

Note: this repo's canonical location is now Stephenson-Software/create-dev-loop (transferred since round 1's review, which still referenced dmccoystephenson/create-dev-loop) — this PR and the branch deletions above target the canonical org.

Test plan

  • python3 scripts/check_docs.py passes.
  • python3 -m unittest discover -s tests -v — 13/13 pass.
  • Verified all 4 deleted branches were MERGED via gh pr list --state all --head <branch> before deleting.
  • Independently re-fetched the flagged RESEARCH.md link to confirm 403 vs. 404 before deciding not to touch it.

🤖 Generated with Claude Code

…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
dmccoystephenson merged commit 9b6aa89 into main Aug 3, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the fix/readiness-round2-followups branch August 3, 2026 06:01
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.
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.

1 participant