Skip to content

docs: drop the roadmap and the dated dependency snapshot - #46

Merged
samuelbharti merged 1 commit into
mainfrom
docs/readme-pass
Sep 16, 2026
Merged

samuelbharti merged 1 commit into
mainfrom
docs/readme-pass

Conversation

@samuelbharti

Copy link
Copy Markdown
Owner

biohttp is flat, so README.md is the GitHub front page, the pkgdown home page
and the text CRAN renders. 215 lines down to 177.

What was stale

Line Said Now
Roadmap, row 5 done, 0.1.2 accepted 2026-09-03 DESCRIPTION is 0.1.3
Dependencies Resolved against CRAN on 2026-07-31, four pinned versions pak::pkg_deps("biohttp")
Dependencies The full recursive set is 14 non-base packages same
Citing Version 0.1.0 is 10.5281/zenodo.21731865 CITATION.cff, which has all three

The roadmap had six rows and every one said done. A table where nothing is
outstanding is a changelog, and NEWS.md already is one.

Kept

The reasons jsonlite, curl and tools are declared. None of them is
guessable, and the jsonlite one in particular explains a failure that only
shows up at runtime on the package's main entry point.

The Why section stays. This is the page a CRAN reader lands on, and why the
package exists is the thing they are deciding.

Moved

The compiled-code argument, including the 210ms against 0.2ms measurement, is
already in CONTRIBUTING.md in a longer form that names the alternatives. The
README keeps the conclusion and points there.

CITATION.cff needed no change. It already carries one identifier per archived
release, matching what Zenodo holds.

The roadmap table had six rows and every one said done, so it recorded history
rather than plans. Its last row said CRAN accepted 0.1.2 on 2026-09-03, while
DESCRIPTION has been at 0.1.3 since.

The dependency section resolved its table against CRAN on 2026-07-31 and pinned
four versions in the prose, then hand-counted a recursive set of fourteen
packages. pak::pkg_deps() answers the same question and cannot go stale, so the
section asks it instead. The reasons jsonlite, curl and tools are declared stay,
because none of them is guessable.

The compiled-code argument is in CONTRIBUTING.md in a fuller form, so the README
keeps the conclusion and points there for the measurement.

The citation section named 0.1.0 as the version to pin. CITATION.cff carries an
identifier for every archived release, so it says that instead.
@samuelbharti
samuelbharti merged commit bf6fbea into main Sep 16, 2026
12 checks passed
@samuelbharti
samuelbharti deleted the docs/readme-pass branch September 16, 2026 14:45
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