Skip to content

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

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

rqbazan merged 4 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 Variable Lab repo):

    • # www, with the GitHub description as the first sentence;
    • what the site is, and its docs/ as a list;
    • Adding a Project;
    • ## Contributing, the License and the Signature.

    "How lab.variable.land is split", "Deploying" and "Local development" move to docs/development.md with their content.

  • docs/add-a-project.md, step 10: a new Project's README now follows the readme.md chapter, with the Tagline and the install command word for word, and its h1 linked to the Project page.

  • LICENSE: a new MIT LICENSE, "Copyright (c) 2026 rcrd ricardo@variable.land".

  • docs/contributing.md and docs/development.md: written beside the site's docs. The CI section drops a stale reason about mise-action: v4.3.0 exports [env].

Verified

  • pnpm rr check passes.
  • On the branch, in light and dark: the README and both docs render, and GitHub shows the Contributing tab.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S

rqbazan and others added 4 commits October 18, 2026 07:38
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
…uting and development guides

The README keeps what the site is, the list of its docs and Adding a Project, then takes
Contributing, License and the Signature. How lab.variable.land is split, Deploying and Local
development move to docs/development.md, and AGENTS.md links the commands there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
jdx/mise-action v4.3.0, which ci.yml pins, exports mise.toml's [env] _.path to later steps
(export_path, true by default), so the reason given for calling the tools through pnpm no
longer holds.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S
Step 10 of add-a-project now checks the README against the vlab-brand
skill's readme.md: the tagline and the install command word for word,
and the title linked to the Project page.

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

⚠️ No Changeset found

Latest commit: 1f8b420

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cloudflare-workers-and-pages

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://docs-readme-structure-variablelab-www.raquirozbazan.workers.dev (commit 1f8b420)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://9032b469-variablelab-www.raquirozbazan.workers.dev 1f8b420 2026-10-18T13:14:18.610Z Visit the dashboard ↗

@rqbazan
rqbazan merged commit 36d907c into main Oct 18, 2026
6 checks passed
@rqbazan
rqbazan deleted the docs/readme-structure branch October 18, 2026 13:16
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