Skip to content

docs: Derive README.md from a README.Rmd - #609

Open
krlmlr wants to merge 1 commit into
claude/readme-goalsfrom
claude/readme-rmd
Open

krlmlr wants to merge 1 commit into
claude/readme-goalsfrom
claude/readme-rmd

Conversation

@krlmlr

@krlmlr krlmlr commented Sep 13, 2026

Copy link
Copy Markdown
Member

The hand-written README.md kept this package out of the shared rendering pipeline. This PR adds a README.Rmd copied from it verbatim, prefixed with the output: cynkratemplate::readme_document front matter and the canonical generated-file comment, and re-renders with cynkratemplate::render_readme().

Rendering also writes index.md for pkgdown — the README.md without the code-of-conduct footer. Both README.Rmd and index.md are added to .Rbuildignore; R CMD build plus tar tzf confirms the tarball ships only README.md.

The rendered README.md differs from the hand-written one only in pandoc's gfm normalisations:

  • the generated-file comment at the top;
  • * bullets written as -;
  • ```R written as ``` r;
  • a blank line after <!-- badges: start -->, after ## Installation, and before ## Connecting to a specific Postgres instance;
  • a trailing space stripped from the R-SIG-DB line, and a trailing empty line dropped from the end of the Heroku connection snippet;
  • --- written as a full-width row of hyphens.

I checked this mechanically: the multiset of words in the old and new README.md is identical apart from the added comment and the markup tokens above, and every URL is unchanged. No evaluated chunks were added — this is a faithful derivation, not new content.

Stacking

This derivation logically belongs below the line-break work, but it is stacked on top of claude/readme-goals to avoid rewriting and force-pushing every branch in the open chain across four repositories.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m


Generated by Claude Code

@krlmlr
krlmlr force-pushed the claude/readme-rmd branch 2 times, most recently from 7e03121 to fc9461c Compare September 13, 2026 20:30
@krlmlr
krlmlr added this pull request to stack #611 September 13, 2026 21:05
The hand-written `README.md` keeps the package out of the shared rendering pipeline,
so this adds a `README.Rmd` copied from it verbatim,
prefixed with the `cynkratemplate::readme_document` front matter and the canonical generated-file comment.

Rendering with `cynkratemplate::render_readme()` also writes `index.md` for pkgdown,
which is the `README.md` without the code-of-conduct footer.
Both `README.Rmd` and `index.md` are added to `.Rbuildignore` so neither ships in the tarball.

The rendered `README.md` differs from the hand-written one only in pandoc's gfm normalisations:
the generated-file comment, `*` bullets written as `-`, ` ```R ` written as ` ``` r `,
blank lines inserted around headings and `<!-- badges: start -->`, trailing whitespace stripped,
and `---` written as a full-width row of hyphens.
No word, URL, or code-block content changes.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
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.

2 participants