Skip to content

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

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

rqbazan merged 3 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):

    • # gh-actions, and "Reusable GitHub Actions for Variable Land." as the first sentence;
    • the actions as a list, Reusable workflows and Versioning;
    • ## Contributing, the License and the Signature.

    "Node action convention", "Dependency cooldown" and "Security linting" move to docs/development.md.

  • The six action READMEs:

    • the title is the folder name used in uses:;
    • one sentence, then the deprecation notice where there is one;
    • Usage, Inputs, Outputs and Requirements, in that order;
    • no Signature or License, since those belong to the repo.
  • LICENSE: a new MIT LICENSE, "Copyright (c) 2025 rcrd ricardo@variable.land".

  • docs/contributing.md and docs/development.md: written from mise.toml, lefthook.yml and the workflows. No changesets: gh-actions doesn't publish.

Verified

  • mise run check-dist, mise run check and mise run test pass.
  • On the branch, in light and dark, 9 files render with square corners and no broken images. GitHub shows the Contributing tab.

Not changed

  • The repo's GitHub description still says "Reusable Github actions for Variable Land".
  • Versioning says to pin "a tag or a commit SHA", and the repo has no tags. Both were already like that, and both are outside this pass.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XRCpaD5QTPJsEjnhikoV2S

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

The root README takes the gh-actions title, the GitHub description, the actions and the
reusable workflow as lists, Versioning, Contributing, License and the Signature. The Node action
convention, the dependency cooldown and security linting move to docs/development.md. Each
action's README takes its folder name as its title, then Usage, Inputs, Outputs and Requirements,
with its concepts after them.

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: ae4f96b

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

@rqbazan
rqbazan merged commit 6a2b7ff into main Oct 18, 2026
5 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