Skip to content

docs: add remarkable-axi to the community catalog - #135

Open
themightychris wants to merge 2 commits into
kunchenguid:mainfrom
themightychris:docs/add-remarkable-axi
Open

docs: add remarkable-axi to the community catalog#135
themightychris wants to merge 2 commits into
kunchenguid:mainfrom
themightychris:docs/add-remarkable-axi

Conversation

@themightychris

Copy link
Copy Markdown
Contributor

Intent

Add remarkable-axi to the AXI community catalog. remarkable-axi is an agent-facing CLI for the reMarkable e-ink tablet cloud, built and published by Jarvus Innovations (npm v1.1.0, MIT, github.com/JarvusInnovations/remarkable-axi). The user asked to add links to this tool here and to awesome-reMarkable, after reviewing recently merged PRs in both repos to match current style and best practice.

Decisions the user made explicitly, so they are deliberate rather than oversights: the author field is "Jarvus Innovations" to match their other catalog entries (slack-axi, gws-axi, harvest-axi, specops, gitsheets-axi, metabase-axi, otter-axi) rather than a personal GitHub handle. The description leads with "Manage content on your reMarkable tablet through the reMarkable cloud" at the user's request, because that is the primary capability; the specifics follow as a second clause.

Other decisions: the entry is appended to the END of the community list in catalog.yaml rather than inserted alphabetically, because that list is in admission order (jj-axi, npm-axi, sqlite-axi ... glab-axi) and catalog.yaml's header comment says to append. README.md and docs/index.html were regenerated with pnpm run docs:gen rather than hand-edited, since those regions are drift-checked by docs:check in CI. The domain "E-ink tablets" is new and deliberately does not collide with an existing domain.

Two commits by design. The first adds the entry; the second corrects the author and description per the user's follow-up. They are separate because the first commit had already been pushed to the gate, and amending it would have rewritten history the gate had seen.

The second commit's README diff touches ~56 lines, but only one row changed content: "Jarvus Innovations" is wider than the previous value, so the generator re-aligned every column separator in that table. git diff -w shows only the intended row.

Docs-only change: no source, tests, or SDK files touched. Gates run locally and passing: pnpm run docs:check, pnpm run format:check, pnpm run lint. Node 24.15.0 and pnpm 11.1.1 to match CI and the packageManager field.

Two earlier runs on this branch were cancelled for environment reasons, not code reasons. The first ran without an intent (pushed with a bare git push) and was superseded by the author/description correction. The second opened its PR against the fork's own main, which was 36 commits behind kunchenguid/axi, so the PR diff swept in unrelated upstream history including the release-please files that Guard generated files correctly rejects. The cause was local remote topology: origin pointed at the fork instead of the parent. That is fixed - origin is now kunchenguid/axi, the fork is a separate remote and the gate's push target, and the fork's main has been fast-forwarded to match. The branch now sits directly on origin/main (5dfe221) with exactly the two intended commits.

What Changed

  • Added a remarkable-axi entry to the community section of catalog.yaml (author: Jarvus Innovations, new "E-ink tablets" domain), describing content management on reMarkable tablets through the reMarkable cloud.
  • Regenerated the catalog regions of README.md and docs/index.html via pnpm run docs:gen; the README table's other rows changed only in column-separator alignment (git diff -w shows just the new row).

Risk Assessment

✅ Low: Docs-only catalog addition confined to catalog.yaml and its generated README/docs regions, internally consistent across all three files and fully conforming to the stated intent.

Testing

Reviewed the two-commit diff against the intent's required constraints, ran the CI docs-drift gate (pnpm run docs:check, passed), verified the package's npm version/license/repo facts, and rendered docs/index.html in a browser to capture a screenshot of the new remarkable-axi catalog row displaying correctly — all checks passed.

  • Evidence: Rendered docs/index.html community catalog showing the new remarkable-axi row (local file: /var/folders/3t/56bdpv2146vbx5drqw9mzkn40000gn/T/no-mistakes-evidence/01KZS3EJ3D6P4G1RP0KPSEJTPG/docs-catalog-remarkable-axi.png)
Evidence: npm registry facts for remarkable-axi
$ npm-axi view remarkable-axi
package:
name: remarkable-axi
version: 1.1.0
license: MIT
repository: https://github.com/JarvusInnovations/remarkable-axi
published: 2026-08-11
Evidence: docs:check drift gate
$ pnpm run docs:check
docs:check ok — generated regions match their sources

Pipeline

Updates from git push no-mistakes

✅ **intent** - passed

✅ No issues found.

✅ **Rebase** - passed

✅ No issues found.

✅ **Review** - passed

✅ No issues found.

✅ **Test** - passed

✅ No issues found.

  • Reviewed git diff 5dfe221..2952190 for catalog.yaml, README.md, docs/index.html — entry appended at end of community list with intent-required author, domain, and description
  • git diff -w 5dfe221..2952190 -- README.md — confirmed only the intended row changed content; remaining diff is column-width realignment
  • pnpm run docs:check — generated README/docs regions match catalog.yaml (same gate CI's docs-check workflow runs); passed
  • npm-axi view remarkable-axi — verified npm v1.1.0, MIT license, repository JarvusInnovations/remarkable-axi
  • Rendered docs/index.html in Chrome via chrome-devtools-axi, confirmed the remarkable-axi row renders with all four columns, and captured a screenshot
  • git status — worktree clean, no transient test artifacts left behind
✅ **Document** - passed

✅ No issues found.

✅ **Lint** - passed

✅ No issues found.

✅ **Push** - passed

✅ No issues found.

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