Skip to content

docs(readme): clarify component ownership and installation - #98

Merged
Yash121l merged 2 commits into
mainfrom
codex/docs-readme-source-ownership
Oct 19, 2026
Merged

Yash121l merged 2 commits into
mainfrom
codex/docs-readme-source-ownership

Conversation

@Heyykrishnna

Copy link
Copy Markdown
Member

Summary

Clarify that the CLI copies editable component source into the application, while installed components still use their declared dependencies. Replace the stale component count with wording that stays accurate as the catalog grows.

Type of Change

  • Documentation

Scope

README.md only; 4 additions and 2 deletions.

Validation

  • Checked the installation wording against bin/cli.mjs and the existing installation guide.
  • Confirmed only README.md changed and all links and code examples are unchanged.
  • git diff --check passed.
  • Application tests were not run for this prose-only change.

@vercel

vercel Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
component-library Ready Ready Preview Oct 19, 2026 4:19am UTC

@Yash121l Yash121l left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. The new wording matches what bin/cli.mjs does, and dropping the hard-coded "59 components" means the README no longer goes stale every time a component is added. Lint, typecheck and the CodeQL analyses pass. The Vercel devclubcompo failure is the account block that also shows on main.

@Yash121l

Copy link
Copy Markdown
Contributor

@Heyykrishnna this is approved, but main requires verified commit signatures and the commits here are unsigned, so it can't merge yet. Can you re-sign and force-push?

One-time setup (SSH signing):

git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/id_ed25519.pub
git config --global commit.gpgsign true

Add the same public key on GitHub under Settings → SSH and GPG keys → New SSH key with key type Signing Key. Also make sure the commit email (khandelwalyatharth39@gmail.com) is a verified email on your GitHub account, otherwise the signature shows as unverified.

Then on this branch:

git rebase --exec 'git commit --amend --no-edit -S' origin/main
git push --force-with-lease

Pushing dismisses the current approval (that's a ruleset setting), so I'll re-approve once the commits show Verified. Auto-merge is enabled, so it merges after that.

@Yash121l
Yash121l merged commit cc39cde into main Oct 19, 2026
14 checks passed
@Yash121l
Yash121l deleted the codex/docs-readme-source-ownership branch October 19, 2026 04:20

This branch was successfully deployed

2 active (1 outdated) deployments
Preview — 5d64a05d Deployed Oct 19, 2026 by vercel[bot]
Preview – component-library — ee01bb5c Deployed Oct 18, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs size/xs Under 10 changed lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants