Skip to content

feat: add the readme chapter, and the README and docs templates - #15

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

rqbazan merged 2 commits into
mainfrom
docs/readme-structure

Conversation

@rqbazan

@rqbazan rqbazan commented Oct 18, 2026

Copy link
Copy Markdown
Member

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

  • The chapter: skills/vlab-brand/readme.md. It holds the rules every README follows (sections, no badges, images with a width and no height, 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 of docs/contributing.md and docs/development.md. SKILL.md gets a row for it.
  • Chapter edits:
    • logo.md names the Logo a README links: .github/readme/logo.svg, pinned to a tag on jsDelivr.
    • project-brand.md says a README's <img> takes a width and no height. With both on an absolute URL, GitHub rounds the corners and puts a gray background behind the image.
  • Templates: templates/project/README.md, templates/project/docs/contributing.md and templates/project/docs/development.md, beside brand/.
  • This README:
    • the One Signature line no longer says "No Project carries it";
    • links and images are absolute, with a width and no height;
    • the palette and the syntax colors are lists written by scripts/build.ts, so the swatches never shrink in a narrow table;
    • a row for the new chapter, ## Contributing and the Signature.
  • This repository's docs: docs/contributing.md and docs/development.md. AGENTS.md lists docs/.
  • Changeset: a minor, for the new chapter and templates.

Verified

  • pnpm check passes.
  • On this branch, in light and dark: all 18 README images load with square corners, the Signature sits aligned at the foot, and GitHub shows the Contributing tab from docs/contributing.md.
  • Both commits are signed and verified.

Two folder views to know about

  • GitHub shows a folder's readme.md the way it shows a README.md. Browsing skills/vlab-brand/ now shows the chapter below the file list.
  • Browsing 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

rqbazan and others added 2 commits October 18, 2026 07:22
- 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-bot

changeset-bot Bot commented Oct 18, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7a2ebe9

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

This PR includes changesets to release 1 package
Name Type
@variablelab/brand Minor

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 c2c9e48 into main Oct 18, 2026
5 checks passed
@rqbazan
rqbazan deleted the docs/readme-structure branch October 18, 2026 12:26
@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