Conversation
krlmlr
force-pushed
the
claude/pkgdown-harmonization
branch
2 times, most recently
from
September 13, 2026 07:46
3625b2e to
b956df9
Compare
krlmlr
force-pushed
the
claude/pkgdown-harmonization
branch
from
September 13, 2026 20:41
b956df9 to
ce754bc
Compare
This was referenced Sep 13, 2026
krlmlr
added this pull request to stack #68
September 13, 2026 21:48
krlmlr
force-pushed
the
claude/pkgdown-harmonization
branch
from
September 13, 2026 21:49
ce754bc to
4b94fa6
Compare
Part of harmonizing how `README.md` and the pkgdown front page are produced across the fleet. The output format becomes `cynkratemplate::readme_document`, which is a `github_document` that also writes the pkgdown front page from the same render. It carries `-smart` and `--wrap=preserve`, matching duckdb-r, which has used them longest: together they keep the pandoc pass close to an identity transform, so no smart quotes and no reflowing to 72 columns. That keeps the rendered file close to its source and makes future diffs sentence-level rather than whole-paragraph. Stating the format by name rather than repeating its settings means the settings live in one place instead of thirty. Rendering is unchanged in how it is invoked: `rmarkdown::render()`, `devtools::build_readme()` and the Knit button all work as before, and all now produce both files. The only new requirement is that cynkratemplate be installed. No prose changes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Output of `cynkratemplate::render_readme()`, with no hand edits. `README.md` changes are the pandoc settings from the previous commit taking effect: `--wrap=preserve` stops badge lines and sentences being broken at 72 columns, and `-smart` leaves quotes and dashes as written. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
krlmlr
force-pushed
the
claude/pkgdown-harmonization
branch
from
September 14, 2026 05:58
4b94fa6 to
1dab560
Compare
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.
Part of a fleet-wide pkgdown harmonization. The tooling this calls lands in cynkra/cynkratemplate#116.
Commits
README.mdwas already in sync withREADME.Rmd, so there is no drift commit.What changes
The output format gains
md_extensions: "-smart"andpandoc_args: ["--wrap=preserve"], matching duckdb-r. They keep the pandoc pass close to an identity transform — no smart quotes, no reflowing to 72 columns — which keeps the rendered file close to its source and makes future diffs sentence-level rather than whole-paragraph.index.mdis new. It is the same render truncated at the first horizontal rule, so the pkgdown front page no longer repeats the boilerplate that pkgdown already puts in its sidebar. It is added to.Rbuildignorein the same commit, since an unignored top-levelindex.mdis anR CMD check --as-cranNOTE.Both files now come from a single pandoc pass, so they cannot drift apart in formatting the way the hand-maintained pairs elsewhere in the fleet have — by four to fourteen months in the worst cases.
Reproducing
🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code