Skip to content

Bring the repository in line with the rest of the stack #13

Description

@nbenn

This package is about to stop being a peripheral alternative and become the only code export in the stack: BristolMyersSquibb/blockr.core#336 drops the generate_code plugin type from core, and #8 makes this the home for what replaces it. The repository is not currently built like something that carries a stack-wide feature — measured against blockr.core, blockr.dock and blockr.session, it is missing most of what the others share.

core dock session here
R files / LOC / exports 66 / 18046 / 324 38 / 14762 / 97 11 / 4327 / 30 4 / 304 / 3
_pkgdown.yml yes yes yes no
NEWS.md yes yes yes no
cran-comments.md yes yes yes no
Vignettes 5 1 1 0
URL / BugReports yes yes yes no
Pages served yes yes yes no
Roxygen 8.0.0 8.0.0 8.0.0 7.3.3
.Rbuildignore lines 16 10 12 3

The size column is why this is a checklist rather than a demand to match blockr.core line for line. The right yardstick is blockr.session: 30 exports, and it still carries a _pkgdown.yml, a NEWS.md and a vignette.

The documentation site is built and then discarded

The pkgdown job runs on every push to main and commits the built site to gh-pages, which was last written at 2026-07-27T17:08:15Z. Nothing serves it. GitHub Pages is not enabled — gh api repos/BristolMyersSquibb/blockr.code/pages returns 404 — and https://bristolmyerssquibb.github.io/blockr.code/ answers 404, where the same URL under blockr.session answers 200. The repository's homepage field is empty; the other three point at their site.

That job took 2m16s in the most recent run, spent on an artifact with no reader.

Checklist

  • Enable GitHub Pages on gh-pages, and set the repository homepage to the resulting URL. The workflow already builds and deploys; this is the settings toggle that makes it visible.
  • Add _pkgdown.yml with url:, bootstrap: 5, light-switch: true and a curated reference: section. The one in blockr.session is 25 lines and is the right size to copy from.
  • Add URL and BugReports to DESCRIPTION. Without them pkgdown has no canonical link and no bug-report link, and utils::bug.report() has nowhere to point.
  • Add NEWS.md. The signature change in Build the board before exporting code #10 is breaking for anyone supplying their own generate_flat_code_server(), and there is currently nowhere to record it — the before/after table went in the PR body instead.
  • Add a vignette covering what this package generates and how it differs from what core produced. That story exists only in the README today, and it becomes the documentation for the stack's only code export.
  • Extend .Rbuildignore, which is three lines against ten to sixteen elsewhere. It needs ^_pkgdown\.yml$, ^docs$, ^cran-comments\.md$, ^CRAN-SUBMISSION$ and ^\.claude — the first two before _pkgdown.yml lands, or the tarball picks it up.
  • Move to roxygen 8.0.0 and Config/roxygen2/version, matching the other three. Regenerating under the current RoxygenNote: 7.3.3 pin is already an extra step for anyone touching the docs here.
  • Title-case the Title field. "Idiomatic code export for 'blockr'" draws a R CMD check NOTE that the others do not.
  • Add cran-comments.md if this package is headed for CRAN alongside the others. Lower priority than the rest, and only matters at submission time.

Two things deliberately left off. There is no .lintr here, and there does not need to be — only blockr.dock has one, for a specific test-file exclusion. There are no test helper or snapshot files either, which is proportionate at 304 lines.

Related: #11 covers the CI and branch-protection half of the same alignment, and is independent of this.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions