Skip to content

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

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).

What's in it

  • README.md (a Project in its own repo):
    • the Sign with a width and no height, so GitHub keeps its corners square;
    • the name in the h1 links to https://lab.variable.land/theme-toggle;
    • a new opening that doesn't repeat the tagline, and ## Install with the requirement from the React peer;
    • ## Development moves to docs/development.md, replaced by ## Contributing;
    • the License line and the Signature.
  • Upgrading title: it becomes "Upgrading from 1.x", because no title holds a scoped package name. Its first sentence names both packages. No repo linked the old anchor.
  • LICENSE: the holder is now "rcrd ricardo@variable.land".
  • docs/contributing.md and docs/development.md: checked against mise.toml, package.json, the workflows and lefthook.yml.
  • Changeset: a patch for @variablelab/theme-toggle, because the README and the LICENSE ship in the tarball.

Verified

  • pnpm rr check and pnpm test pass (25 tests).
  • npm pack --dry-run lists LICENSE and README.md.
  • On the branch, in light and dark: square corners, the h1 link, the Signature aligned, and no table splits a name. GitHub shows the Contributing tab.
  • The README's links to blob/main/docs/… resolve after the merge.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S

rqbazan and others added 3 commits October 18, 2026 07:34
… guides

The README takes the structure of a Project in its own repository: the
name links to the Project page, Install states the React requirement,
and the Development section moves to docs/development.md. Contributing
links both guides, License takes the Project form, and the Signature
closes the page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
GitHub shows a code span in a title as a gray block the size of the title,
so the title says "Upgrading from 1.x" and its first sentence names both
packages.

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: 442e1ad

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

This PR includes changesets to release 1 package
Name Type
@variablelab/theme-toggle 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 4ad51dc into main Oct 18, 2026
8 checks passed
@rqbazan
rqbazan deleted the docs/readme-structure branch October 18, 2026 13:15
@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