Skip to content

Commit eedde77

Browse files
committed
docs(readme): drop redundant version columns from Skill Catalog table
Seven of the eight catalog rows showed identical React PDF Kit and pdfjs-dist version ranges, so the columns were noise. The override skill's distinct pdfjs-dist v4 dependency is still surfaced through its own description and through the dedicated Troubleshooting section. Per-skill compatibility ranges remain machine-readable in each skill's YAML frontmatter (metadata.react_pdf_kit_version, metadata.pdfjs_dist_version), which is the canonical source of truth per the catalog's versioning policy. Catalog table is now two columns: Skill | Description. CHANGELOG.md adds a [1.0.0-beta.2] section recording the README polish. No skill content, sample, script, or workflow changes since v1.0.0-beta.1. Conformance: scripts/verify-all.sh passes 8/8. scripts/check-changelog.sh v1.0.0-beta.2 passes.
1 parent 2f8ea67 commit eedde77

2 files changed

Lines changed: 41 additions & 15 deletions

File tree

CHANGELOG.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,31 @@ range under a **Validated against** line.
1919

2020
## [Unreleased]
2121

22-
(No changes yet since v1.0.0-beta.1.)
22+
(No changes yet since v1.0.0-beta.2.)
23+
24+
## [1.0.0-beta.2] - 2026-05-15
25+
26+
README polish on top of `v1.0.0-beta.1`.
27+
28+
**Validated against**: `@react-pdf-kit/viewer` `>=1.0.0 <2.0.0`
29+
30+
### Changed
31+
32+
- `README.md` Skill Catalog table no longer carries the
33+
`React PDF Kit` and `pdfjs-dist` version-range columns. Seven of
34+
the eight catalog rows showed identical ranges, so the columns
35+
were noise. The override skill's distinct `pdfjs-dist` v4
36+
dependency is still surfaced through its own description in the
37+
table and through the dedicated Troubleshooting section. Per-skill
38+
compatibility ranges remain machine-readable in each skill's YAML
39+
frontmatter (`metadata.react_pdf_kit_version` and
40+
`metadata.pdfjs_dist_version`), which is the canonical source of
41+
truth.
42+
43+
### Catalog content
44+
45+
(No skill content changes since `v1.0.0-beta.1`. All eight skills,
46+
sample scaffolds, scripts, and CI workflows ship unchanged.)
2347

2448
## [1.0.0-beta.1] - 2026-05-14
2549

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,21 @@ ask about React PDF Kit. Example prompt: *"Add a PDF viewer for
6868
## Skill Catalog
6969

7070
The catalog is populated as skills are merged. Each row links to the
71-
skill's `SKILL.md` and shows its supported library version range.
72-
73-
| Skill | Description | React PDF Kit | pdfjs-dist |
74-
|-------|-------------|---------------|------------|
75-
| [`react-pdf-kit-setup`](./skills/react-pdf-kit-setup/SKILL.md) | Set up @react-pdf-kit/viewer in a generic React app, including PDF.js worker setup and the canonical provider chain. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
76-
| [`react-pdf-kit-nextjs-app-router`](./skills/react-pdf-kit-nextjs-app-router/SKILL.md) | Integrate @react-pdf-kit/viewer into a Next.js App Router project, including PDF.js worker configuration. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
77-
| [`react-pdf-kit-nextjs-pages-router`](./skills/react-pdf-kit-nextjs-pages-router/SKILL.md) | Integrate @react-pdf-kit/viewer into a Next.js Pages Router project with SSR-safe dynamic import. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
78-
| [`react-pdf-kit-vite`](./skills/react-pdf-kit-vite/SKILL.md) | Integrate @react-pdf-kit/viewer into a Vite project, including the PDF.js worker import. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
79-
| [`react-pdf-kit-worker-config`](./skills/react-pdf-kit-worker-config/SKILL.md) | Configure the PDF.js worker URL across supported bundlers (Vite, Turbopack, webpack, Next.js App Router). | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
80-
| [`react-pdf-kit-toolbar-customization`](./skills/react-pdf-kit-toolbar-customization/SKILL.md) | Add, remove, or replace individual toolbar tools while preserving Radix-based accessibility. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
81-
| [`react-pdf-kit-custom-layout`](./skills/react-pdf-kit-custom-layout/SKILL.md) | Build a headless / custom layout for the viewer using only the documented hooks. | `>=1.0.0 <2.0.0` | `>=5.0.0 <6.0.0` |
82-
| [`react-pdf-kit-nextjs14-pdfjs-override`](./skills/react-pdf-kit-nextjs14-pdfjs-override/SKILL.md) | Override pdfjs-dist to v4 to work around the Next.js 14 webpack ESM interop bug. | `>=1.0.0 <2.0.0` | `>=4.0.0 <5.0.0` |
71+
skill's `SKILL.md`. Per-skill compatibility (React PDF Kit and
72+
`pdfjs-dist` version ranges) lives in each skill's YAML frontmatter
73+
under `metadata.react_pdf_kit_version` and
74+
`metadata.pdfjs_dist_version`.
75+
76+
| Skill | Description |
77+
|-------|-------------|
78+
| [`react-pdf-kit-setup`](./skills/react-pdf-kit-setup/SKILL.md) | Set up `@react-pdf-kit/viewer` in a generic React app, including PDF.js worker setup and the canonical provider chain. |
79+
| [`react-pdf-kit-nextjs-app-router`](./skills/react-pdf-kit-nextjs-app-router/SKILL.md) | Integrate `@react-pdf-kit/viewer` into a Next.js App Router project, including PDF.js worker configuration. |
80+
| [`react-pdf-kit-nextjs-pages-router`](./skills/react-pdf-kit-nextjs-pages-router/SKILL.md) | Integrate `@react-pdf-kit/viewer` into a Next.js Pages Router project with SSR-safe dynamic import. |
81+
| [`react-pdf-kit-vite`](./skills/react-pdf-kit-vite/SKILL.md) | Integrate `@react-pdf-kit/viewer` into a Vite project, including the PDF.js worker import. |
82+
| [`react-pdf-kit-worker-config`](./skills/react-pdf-kit-worker-config/SKILL.md) | Configure the PDF.js worker URL across supported bundlers (Vite, Turbopack, webpack, Next.js App Router). |
83+
| [`react-pdf-kit-toolbar-customization`](./skills/react-pdf-kit-toolbar-customization/SKILL.md) | Add, remove, or replace individual toolbar tools while preserving Radix-based accessibility. |
84+
| [`react-pdf-kit-custom-layout`](./skills/react-pdf-kit-custom-layout/SKILL.md) | Build a headless / custom layout for the viewer using only the documented hooks. |
85+
| [`react-pdf-kit-nextjs14-pdfjs-override`](./skills/react-pdf-kit-nextjs14-pdfjs-override/SKILL.md) | Override `pdfjs-dist` to v4 to work around the Next.js 14 webpack ESM interop bug. |
8386

8487
## Troubleshooting
8588

@@ -99,8 +102,7 @@ via a package-manager override and the build will succeed.
99102
## When things go wrong
100103

101104
These behaviors are governed by the upstream
102-
[vercel-labs/skills](https://github.com/vercel-labs/skills) CLI; reading
103-
them here helps you interpret errors quickly.
105+
[vercel-labs/skills](https://github.com/vercel-labs/skills) CLI; reading them here helps you interpret errors quickly.
104106

105107
- **`no matching skill` after `npx skills add <name>`**: the name is
106108
wrong or the skill has been renamed. Symptom: CLI exits non-zero with

0 commit comments

Comments
 (0)