Skip to content

Link related Quarto templates from the README - #61

Merged
d-morrison merged 2 commits into
mainfrom
claude/fix-36-link-templates
Sep 15, 2026
Merged

d-morrison merged 2 commits into
mainfrom
claude/fix-36-link-templates

Conversation

@d-morrison

Copy link
Copy Markdown
Collaborator

Closes #36.

Independent of #57/#58/#60 — touches only the README, so this targets main directly rather than stacking.

What changed

A "Related templates" section before Support, carrying the link the issue names plus the two lab siblings:

Template What it actually is
NOAA-quarto-book a type: book template that also builds PDF and docx
qwt the Quarto website template, not a book
rpt the R package template

Why the siblings are grouped separately

The issue asks for "other quarto book templates." Only the NOAA one is that. Reading the siblings' READMEs, qwt is a website template and rpt is an R package template — so they're listed under a separate heading as adjacent project types. Filing them as book templates would have been simply false, and this PR series has already produced one committed claim about another repo that turned out to be wrong.

A fourth candidate I considered doesn't exist at all; git ls-remote said so, and it was dropped rather than guessed at.

Verification

All three URLs confirmed live with git ls-remote, not curl — the session proxy answers curl https://github.com/... with 403 whether or not the repo exists, so curl would have been useless as an existence check here.

README.md is generated from README.Rmd, so the source was edited and the output regenerated with rmarkdown rather than hand-edited. One wrinkle worth naming: a fresh render also drops a blank line between the badges: start / badges: end comments, a toolchain-version artifact unrelated to this change. That line is restored, so the diff is 15 additions and 0 deletions rather than carrying unrelated churn.

New prose passes the semantic-line-break, list-item-splice and non-standard-character checks, run locally with CI's configuration before pushing.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Lx1hhHu58mXq9DfJsAxkHn


Generated by Claude Code

Closes #36.

Adds a "Related templates" section before Support, carrying the link the issue
names plus the two lab siblings, each described by what it actually is:

  NOAA-quarto-book  a `type: book` template that also builds PDF and docx
  qwt               the Quarto website template, not a book
  rpt               the R package template

The issue asks for "other quarto book templates" and gives one link. The
siblings are grouped separately and labelled as adjacent project types rather
than book templates, because they are not: reading their READMEs, qwt is a
website template and rpt is an R package template. Filing them under "other
Quarto book templates" would have been wrong.

All three URLs were confirmed to resolve with `git ls-remote` rather than
curl, which the session proxy answers with 403 for github.com regardless of
whether the repo exists. A fourth candidate template turned out not to exist
and was dropped rather than guessed at.

Edited README.Rmd and regenerated README.md with rmarkdown, per the generated-
from header, rather than editing the output by hand. A fresh render also drops
a blank line between the badges comments, which is a toolchain-version artifact
unrelated to this change; that line is restored so the diff is additions only.

Verified: README.md gains 15 lines and loses none; the new prose passes the
semantic-line-break, list-item-splice and non-standard-character checks, run
locally with CI's configuration.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Lx1hhHu58mXq9DfJsAxkHn
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Spellcheck went red on the four proper nouns the README section introduces:
docx, NOAA, qwt and rpt. Each is a real name (a file format, the NOAA
template, and two lab repositories) rather than a misspelling, so the fix is
the wordlist, which is what the failure message itself recommends.

Kept in C sort order to match the existing file.

Verified with spelling::spell_check_package("."), which is the package-aware
entry point the action uses and now reports nothing. Worth recording why that
matters: spell_check_files() on the two READMEs instead reports `qbt`, because
the package-aware path ignores the package's own name and the file-level one
does not. CI never flagged `qbt`, so the file-level result was an artifact of
the wrong entry point rather than a real second failure to chase.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Lx1hhHu58mXq9DfJsAxkHn

Copy link
Copy Markdown
Collaborator Author

build-deploy failed on b8326fd, and it is not this PR's change. Recording it rather than letting a red check sit unexplained.

The failure is step 14, "Deploy PR Preview". Every step before it passed, including the ones that would catch a bad README:

  6 success  Render
  9 success  Re-render with metadata
 13 success  Add home page banner
 14 failure  Deploy PR Preview

The book rendered. What failed is the push to gh-pages via github-pages-deploy-action, which is shared infrastructure rather than anything this diff touches — and a README-only change cannot break a render that succeeded two steps earlier anyway.

The likely cause is contention I created: four PRs (#57, #58, #60, #61) were open at once, each deploying a preview to the same gh-pages branch, and concurrent pushes to one branch race. Supporting evidence rather than assertion: build-deploy is green on main (8e843fa), on #57 (321415e) and on #60 (a52d08b), so the job is not broken in general.

No re-run needed and none spent. The wordlist fix in ff0b160 superseded that head, and its build-deploy is running now — 18 checks already green on it, nothing red. That run is the verdict. If it fails again on the current head, the contention theory is wrong and it becomes mine to root-cause properly; I am watching for exactly that rather than assuming it will pass.

Worth flagging beyond this PR: if concurrent preview deploys really do race, that will recur whenever several PRs are open together, which is normal for this repo. A concurrency: group on the preview job keyed to gh-pages would serialize them. That is a change to Morrison-Lab/gha's preview workflow, not something this PR should reach into, and I have read-only access there.


Generated by Claude Code

@github-actions

Copy link
Copy Markdown
Contributor

Claude finished reviewView run


Review

This round's diff (b8326fdb..ca2f8e80) is a single-file, 4-line addition to inst/WORDLIST, adding NOAA, docx, qwt, and rpt. These are exactly the new proper nouns/acronyms introduced by the previously-reviewed commit's README.Rmd/README.md changes (NOAA-quarto-book, "PDF and docx", qwt, rpt), so this is a legitimate spell-check wordlist fix, not unrelated churn.

Ordering check: the wordlist appears to be sorted case-sensitively (ASCII order, uppercase before lowercase) — DOCX, EPUB, NOAA, SERG, TinyTeX, UCD, docx, emplate, glitchy, lintr, ook, qwt, rpt, rulesets, uarto. All four new entries land in the correct alphabetical position for that convention, consistent with the file's existing style, so this looks like a proper spelling::update_wordlist()-generated diff rather than a manually hand-edited list.

Completeness: no other new out-of-dictionary tokens were introduced by the prior commit's prose (Quarto, PDF, README, etc. are either already covered by existing wordlist entries or standard dictionary words), so nothing appears to be missing from this addition.

No issues found in this round. The prior round's verdict (posted 2026-09-15T01:20:14Z, commit b8326fdb0c114bbc84ff394923cb81cdbd2fb79b) was Ready for merge, and this round's change is a small, correctly-scoped follow-up that only extends the spelling wordlist to match that already-reviewed content — it introduces no new concerns.

Verdict

Ready for merge

Structured Review Data (JSON)
{
  "schema_version": "1.1",
  "reviewer": "claude",
  "commit_sha": "ca2f8e80ac99f5b746bb7ea493cf885d699fa1b6",
  "verdict": "CLEAN",
  "findings": [],
  "detailed_assessment": "inst/WORDLIST gained four entries (NOAA, docx, qwt, rpt) that exactly match the new proper nouns introduced in the already-reviewed README changes, with correct case-sensitive alphabetical placement and no stray or missing tokens.",
  "holistic_assessment": "This follow-up commit only extends the spell-check wordlist to cover previously-reviewed documentation content, so it introduces no regression risk, no scope creep beyond issue #36, and requires no further validation beyond the prior round's approval."
}

Reviewed commit: ff0b160

@github-actions

Copy link
Copy Markdown
Contributor

💰 Cost: $0.1584 (review) — run

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-09-15 02:20 UTC

@d-morrison
d-morrison merged commit 94e0c65 into main Sep 15, 2026
24 checks passed
@d-morrison
d-morrison deleted the claude/fix-36-link-templates branch September 15, 2026 02:17
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.

link to other quarto book templates

2 participants