Skip to content

docs: Autolink the inline code in the README's prose - #204

Open
krlmlr wants to merge 1 commit into
mainfrom
claude/readme-autolink
Open

krlmlr wants to merge 1 commit into
mainfrom
claude/readme-autolink

Conversation

@krlmlr

@krlmlr krlmlr commented Sep 26, 2026 •

Copy link
Copy Markdown
Member

Regenerated README.md with the readme_document format, which links inline code spans in prose that resolve to a documented object and leaves everything else alone: code blocks, line breaks, and any span downlit cannot resolve.

2 links added: here() to its own reference, and one base R topic to rdrr.io, which is correct — base R has no documentation site. Only README.md changes; index.md is deliberately not autolinked, because pkgdown runs downlit over the front page itself and linking here would double up.

The rendered output is unaffected by where the repository is checked out: this README's chunks print a project root, and main already normalizes it to /home/here in a hook, which is what makes the file stable for whoever renders it next.

Ready for review: cynkra/cynkratemplate#135 is merged, so this is reproducible from the cynkratemplate on its main (0.0.2.9033). Re-rendered against that build, the committed file comes back byte for byte, and a second pass is a no-op.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m

Regenerated with the `readme_document` format from cynkra/cynkratemplate#135,
which links inline code spans in prose that resolve to a documented object
and leaves everything else alone:
code blocks, line breaks, and any span downlit cannot resolve.

Only `README.md` changes.
`index.md` is deliberately not autolinked -- pkgdown runs downlit over the
front page itself, so linking here would double up.

This cannot be reproduced until #135 is merged,
so it must not land before it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
@krlmlr
krlmlr marked this pull request as ready for review September 27, 2026 05:43

This branch has not been deployed

No deployments
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