docs: Harmonize README and pkgdown front page rendering - #56
Open
krlmlr wants to merge 2 commits into
Open
Conversation
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
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. This was the last repository in the sweep with no pull request at all — the branch was built but the push failed at the time, so it sat unpushed until now.
What changes
README.Rmddeclaresoutput: cynkratemplate::readme_document— agithub_documentthat also writes the pkgdown front page from the same render, with-smartand--wrap=preserveso diffs stay sentence-level. Stating the format by name rather than repeating its settings means the settings live in one place instead of thirty.index.mdis newly added: the README's trailing boilerplate belongs on GitHub while pkgdown puts that material in its sidebar, so the two files genuinely differ. It is added to.Rbuildignore, sinceR CMD check --as-cranotherwise reports it as a non-standard top-level file.The output format lands in cynkra/cynkratemplate#116, and the CI step that will keep these files current in cynkra/cynkratemplate#118.
Why this targets
mainElsewhere in the fleet this change is stacked on the
pak::pak()README PR and targets it. This repository has no such branch, so the PR targetsmainand carries the pending CI alignment with cynkratemplate as its first three commits. Review the last two commits for the README work itself.Two consecutive renders are byte-identical — checked before committing, because cynkra/cynkratemplate#118 re-renders in CI and commits the result, and a README that rendered differently each time would commit noise nightly.
🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code