Skip to content

docs: apply the Variable Lab README structure, add LICENSE and the contributing and development guides - #278

Merged
rqbazan merged 3 commits into
mainfrom
docs/readme-structure
Oct 18, 2026
Merged

rqbazan merged 3 commits into
mainfrom
docs/readme-structure

Conversation

@rqbazan

@rqbazan rqbazan commented Oct 18, 2026

Copy link
Copy Markdown
Member

Applies the README structure from the vlab-brand skill's readme.md (brand#15) to the root and to all 13 published packages.

What's in it

  • README.md (a monorepo with several Projects):

    • # dx;
    • Projects and Repository as lists, so a hyphenated name never breaks in a narrow column;
    • ## Contributing, the License and the Signature.

    Usage, Development, Release and the link to run-run/CLAUDE.md move to docs/.

  • run-run/cli and vland/cli (a Project's package):

    • the h1 links to the Project page;
    • Prerequisites becomes part of Install, and the requirement comes from engines;
    • vland's Install starts with pnpm add -g @variablelab/vland;
    • the CLI reference stays in Usage;
    • the License line and the Signature.

    run-run's ## Plugins table keeps the form that plugin-docs.test.ts checks.

  • The other 11 packages:

    • the title is the folder name, and the first sentence names the package and its Project;
    • the License line and the Signature;
    • Surface becomes Commands;
    • clibuddy and loggy say they are internal;
    • @rrlab/tsdown-config gets the README it didn't have.
  • LICENSE: a new MIT LICENSE at the root, "Copyright (c) 2025 rcrd ricardo@variable.land", with an identical copy in each of the 13 package folders, so every tarball carries it.

  • docs/contributing.md and docs/development.md: written from the old README sections, the workflows, lefthook.yml, mise.toml and package.json. Neither counts the plugins.

  • Changeset: one file with a patch for each of the 13 packages.

Verified

  • pnpm test, including plugin-docs.test.ts, and pnpm rr check pass.
  • npm pack --dry-run lists LICENSE and README.md in all 13 packages.
  • On the branch, in light and dark, 16 files: square corners, the h1 links, the Signature, and no table splits a name. GitHub shows the Contributing tab.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S

rqbazan and others added 3 commits October 18, 2026 07:45
npm puts only the package folder's LICENSE in the tarball, so each of the
13 published packages carries a copy of the root LICENSE.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
…t guides

The root README lists the Projects and the folders, and links the two new
guides in docs/. run-run and vland link their Project page from the h1,
fold the requirement into Install and link the CLI reference from Usage.
Every other package README takes its folder name as its title and names
its Project. @rrlab/tsdown-config gets its first README. Every README ends
with the license and the Signature.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
@rrlab/biome-config and @rrlab/ts-config hold only JSON presets and
declare no engines.node, so the development guide names them as the
exception. The changeset no longer says the README ends with the
license: it ends with the Signature.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
@changeset-bot

changeset-bot Bot commented Oct 18, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7b8229e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages
Name Type
@rrlab/cli Patch
@rrlab/astro-plugin Patch
@rrlab/biome-plugin Patch
@rrlab/oxc-plugin Patch
@rrlab/ts-plugin Patch
@rrlab/tsdown-plugin Patch
@rrlab/vitest-plugin Patch
@rrlab/biome-config Patch
@rrlab/ts-config Patch
@rrlab/tsdown-config Patch
@variablelab/vland Patch
@variablelab/clibuddy Patch
@variablelab/loggy Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@rqbazan
rqbazan merged commit b463230 into main Oct 18, 2026
10 checks passed
@rqbazan
rqbazan deleted the docs/readme-structure branch October 18, 2026 13:16
@vland-bot vland-bot Bot mentioned this pull request Oct 18, 2026
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