Repository navigation
docs: apply the Variable Lab README structure, add LICENSE and the contributing and development guides - #278
Merged
Merged
Conversation
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 detectedLatest commit: 7b8229e The changes in this PR will be included in the next version bump. This PR includes changesets to release 13 packages
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 |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies the README structure from the
vlab-brandskill'sreadme.md(brand#15) to the root and to all 13 published packages.What's in it
README.md (a monorepo with several Projects):
# dx;## Contributing, the License and the Signature.Usage, Development, Release and the link to
run-run/CLAUDE.mdmove todocs/.run-run/cli and vland/cli (a Project's package):
engines;pnpm add -g @variablelab/vland;run-run's
## Pluginstable keeps the form thatplugin-docs.test.tschecks.The other 11 packages:
SurfacebecomesCommands;@rrlab/tsdown-configgets 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.tomlandpackage.json. Neither counts the plugins.Changeset: one file with a patch for each of the 13 packages.
Verified
pnpm test, includingplugin-docs.test.ts, andpnpm rr checkpass.npm pack --dry-runlists LICENSE and README.md in all 13 packages.🤖 Generated with Claude Code
https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S