Repository navigation
docs: apply the Variable Lab README structure, and move the repo docs to docs/ in lowercase - #48
Merged
Merged
Conversation
docs/CONTRIBUTING.md becomes docs/contributing.md and docs/DEVELOPMENT.md becomes docs/development.md, with every link to them updated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
The holder line becomes "rcrd <ricardo@variable.land>", and package/ gets an identical copy of the root LICENSE, since npm only packs the package folder's. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
The root README links the package README and the docs, lists the folders, and ends with Contributing, License and the Signature. The package README gains Usage, an Entry points table and absolute links, and package.json names its directory so npm resolves the repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
contributing.md takes Issues, Pull requests, Changesets and Releases, with preview releases under Pull requests. development.md takes Layout, Setup, Tasks and CI, with the git hooks under CI. Claims now match mise.toml, lefthook.yml and the workflows, and the examples are no longer counted. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
The setup and commands left the README for docs/development.md, so the line that sent agents to the README for them now names the guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
The env:pack row named package/.local/variablelab-env.tgz in a sentence cell, and GitHub split it at the hyphen at narrower widths. The row now names the folder, and the full path stays in the rest of the guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
🦋 Changeset detectedLatest commit: 35cf847 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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
1 participant
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).What's in it
## Contributing;## Usagewith anenv.tschecked againstpackage/src;## Documentationstarts at the Getting started URL that www uses;repository.directoryispackage, so npm resolves paths from the package folder.package/LICENSE, because npm only puts the package folder's LICENSE in the tarball.docs/CONTRIBUTING.mdanddocs/DEVELOPMENT.mdare nowdocs/contributing.mdanddocs/development.md, renamed withgit mv;CLAUDE.md, the README,docsite/README.mdanddocsite/content/docs/community.mdx.@variablelab/env.Verified
mise run checkpasses.npm pack --dry-runinpackage/lists LICENSE and README.md.git grepfinds no uppercase doc name left.🤖 Generated with Claude Code
https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S