Skip to content

docs: Replace the dead Travis and AppVeyor badges with the one that runs - #61

Open
krlmlr wants to merge 11 commits into
claude/pkgdown-harmonizationfrom
claude/drop-dead-ci-badges
Open

krlmlr wants to merge 11 commits into
claude/pkgdown-harmonizationfrom
claude/drop-dead-ci-badges

Conversation

@krlmlr

@krlmlr krlmlr commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

The README carries a Linux build badge from travis-ci.org and a Windows one from ci.appveyor.com. NEWS.md for 1.0.1.9002 records "Turn off Travis and AppVeyor (#10)", so neither has reported anything for many releases.

The checks that actually run live in .github/workflows/R-CMD-check.yaml, whose name: is rcc — the badge the rest of this fleet carries. The block also gains the <!-- badges: start --> / <!-- badges: end --> markers that usethis uses to find it.

On the base branch. This targets claude/pkgdown-harmonization (#56) rather than main, and not for stacking convenience: main declares output: downlit::readme_document, and downlit exports no such object, so README.md cannot be regenerated on main at all — the render aborts with 'readme_document' is not an exported object from 'namespace:downlit'. That is worth knowing independently of this change; #56 is what fixes it. Rendering works on that branch, so the README.md and index.md here are a real render rather than a hand edit, and two consecutive renders are byte-identical.

This is not one of the documentation chain's four links — it is an independent fix that happens to need a working render.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m


Generated by Claude Code

@krlmlr
krlmlr force-pushed the claude/drop-dead-ci-badges branch from 1fcc6af to 0dd5486 Compare September 13, 2026 20:33
@krlmlr
krlmlr force-pushed the claude/pkgdown-harmonization branch 2 times, most recently from 7f99c1e to 41314a6 Compare September 13, 2026 21:41
`NEWS.md` for 1.0.1.9002 records "Turn off Travis and AppVeyor (#10)",
so both badges have reported nothing for many releases.
The checks that actually run live in `.github/workflows/R-CMD-check.yaml`, whose `name:` is `rcc`,
and that is the badge the rest of this fleet carries.

The block also gains the `<!-- badges: start -->` / `<!-- badges: end -->` markers,
which `usethis` uses to find it.

Based on the pkgdown harmonization branch rather than `main` on purpose:
`main` declares `output: downlit::readme_document`,
and `downlit` exports no such object,
so `README.md` cannot be regenerated there at all.
Rendering works on this branch, so the committed output is a real render rather than a hand edit --
two consecutive renders are byte-identical.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
@krlmlr
krlmlr force-pushed the claude/drop-dead-ci-badges branch from 0dd5486 to 5caf9f9 Compare September 14, 2026 05:45
krlmlr and others added 10 commits September 26, 2026 19:27
* docs: Adopt the shared README rendering configuration

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

* docs: Render README.md and index.md

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

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
* docs: Break lines at meaning boundaries

Reformatting only, no wording changes: prose in README.Rmd and the
roxygen comments under R/ now breaks at sentence and clause boundaries
rather than wrapping to a fixed width.

The payoff is sentence-level diffs. A reworded sentence touches one
line instead of reflowing the paragraph around it, so review sees the
change and not the rewrap.

man/*.Rd is regenerated because roxygen2 passes source line breaks
through to the .Rd. The rendered help is byte-identical -- checked with
tools::Rd2txt() over every topic -- as is the rendered README.

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

* docs: Start every broken sentence on its own line

A sentence that spans more than one line, and the sentence after it, must
each begin at the start of a line. The maintainer note at the top of
README.Rmd was still wrapped to a fixed width, so two sentences started
mid-line; README.md and index.md are re-rendered from it.

The remaining detector hits are bibliographic entries in @references and
in the "Reference:" blocks of the foodwebs descriptions, where the line
breaks separate authors, title and venue rather than sentences.

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

* docs: Indent continuation lines to keep sentence spacing

Continuation lines of a roxygen paragraph now carry two spaces after `#'`
instead of one.
The first line of a paragraph, and every tag line, keeps its single space.

roxygen2 strips `#'` plus exactly one space, so the extra space reaches the `.Rd`,
and `Rd2txt()` renders a line break followed by indentation as two spaces rather than one.
That is what lets a sentence pair keep its gap across a line break.

This package sets `Roxygen: list(markdown = TRUE)`, and commonmark strips the indent again,
so here the change is a source convention only.
The rendered help is byte-identical, checked with `tools::Rd2txt()` over every topic,
and `man/` is unchanged.

Most of the dataset documentation already indents its continuation lines by three spaces,
so only four lines needed the second space.
The `\describe{}` blocks that carry the per-dataset provenance keep the indentation their structure needs.

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

* docs: Drop the continuation-line indent

The two-space continuation indent never reached the `.Rd` files.
This package sets `markdown = TRUE` in its `Roxygen` field,
and commonmark strips the leading whitespace of a continuation line before roxygen2 writes the topic,
so the indent only ever lived in the source.
It bought nothing there, so it comes out.

man/ is left to CI, which regenerates it from these sources.

A line break which follows the end of a sentence currently renders as one space rather than two.
Restoring that gap needs a patched roxygen2, which is a separate decision and a separate pull request,
so it is deliberately not part of this change.

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

* chore: Auto-update from GitHub Actions

Run: https://github.com/igraph/igraphdata/actions/runs/34784578558
… actions (cynkra/cynkratemplate#139)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
…p` and `rhub-check` actions (cynkra/cynkratemplate#145)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Claude <noreply@anthropic.com>
…adges

# Conflicts:
#	README.Rmd
#	README.md
#	index.md

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.

2 participants