Repository navigation
feat: add the readme chapter, and the README and docs templates - #15
Merged
Merged
Conversation
- skills/vlab-brand/readme.md: the rules every README follows, the six structures, what is copied and what is linked, and the docs/contributing.md and docs/development.md every repository keeps. - templates/project/: README.md, docs/contributing.md and docs/development.md beside the brand/ folder. - logo.md: the Logo a README links, pinned to a tag on jsDelivr. - project-brand.md: a README's <img> takes a width and no height, so GitHub keeps its corners square. - README.md: the One Signature line, absolute links and images, the palette as lists (build.ts), the readme row, Contributing and the Signature. - docs/contributing.md and docs/development.md for this repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
… visible The copied-and-linked list now says the Project's page takes its text from the README, instead of a line that read against the tagline being copied from the page. Two template placeholders get a comma, so GitHub shows them as text instead of dropping them as unknown tags. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
🦋 Changeset detectedLatest commit: 7a2ebe9 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
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.
Adds the structure every Variable Lab README follows, and the contributing and development docs every repository keeps, then applies it to this repository.
What's in it
skills/vlab-brand/readme.md. It holds the rules every README follows (sections, no badges, images with awidthand noheight, absolute links where npm shows the README, tables, the Signature, the license line,## Contributing), the six structures, what is copied and what is linked, and the shape ofdocs/contributing.mdanddocs/development.md.SKILL.mdgets a row for it.logo.mdnames the Logo a README links:.github/readme/logo.svg, pinned to a tag on jsDelivr.project-brand.mdsays a README's<img>takes awidthand noheight. With both on an absolute URL, GitHub rounds the corners and puts a gray background behind the image.templates/project/README.md,templates/project/docs/contributing.mdandtemplates/project/docs/development.md, besidebrand/.widthand noheight;scripts/build.ts, so the swatches never shrink in a narrow table;## Contributingand the Signature.docs/contributing.mdanddocs/development.md.AGENTS.mdlistsdocs/.Verified
pnpm checkpasses.docs/contributing.md.Two folder views to know about
readme.mdthe way it shows aREADME.md. Browsingskills/vlab-brand/now shows the chapter below the file list.templates/project/shows the README template. Its header is blank there, because GitHub drops the<project>-style placeholders inside HTML. The body placeholders are written so they stay visible.🤖 Generated with Claude Code
https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S