Skip to content

🍕 Add clay vite to README.md and docs/cli.md - #264

Merged
jjpaulino merged 1 commit into
masterfrom
jordan/document-vite-in-readme
Sep 15, 2026
Merged

jjpaulino merged 1 commit into
masterfrom
jordan/document-vite-in-readme

Conversation

@jjpaulino

Copy link
Copy Markdown
Member

TL;DR — for reviewers short on time

  • Outcome and scope: Docs-only. clay vite has never appeared in either primary entry-point doc (README.md, docs/cli.md) since it was introduced several rc's ago — a reader starting from either has no way to discover it exists, only CLAY-VITE.md's deep-dive covers it. Adds a vite command-list entry and a short ## Vite section (matching the sibling ## Compile section's depth) to both files, pointing to CLAY-VITE.md for the full picture rather than duplicating it.
  • Risk: None. No .js file touched.
  • Validation: npm test (lint + all 456 tests) green — unaffected, as expected for a docs-only change.
  • If you only review one thing: README.md L858–L890 — the new ## Vite section; docs/cli.md's addition mirrors it.
  • Changes, in logical review order:
    1. README.md L858–L890 — new ## Vite section + Commands-list entry.
    2. docs/cli.md — the same addition, in this file's own Docusaurus-anchor style.

Feature Info

Description

Predates and is unrelated to the specific fixes in #258#263 — surfaced while making sure docs were current after landing that work. A whole command with its own dedicated reference doc had zero discoverability from either primary entry point.

🤖 Generated with Claude Code

`clay vite` has never been mentioned in either of claycli's two primary
entry-point docs (README.md, docs/cli.md) since it was introduced several
release candidates ago -- it existed only in the separate CLAY-VITE.md
deep-dive, with zero discoverability from the docs a new reader actually
starts with. This predates and is unrelated to this pass's specific fixes,
but surfaced while making sure documentation is current after landing them.

Adds a `vite` entry to the Commands list in both files, and a short ## Vite
section (command, arguments, examples) matching the existing style/depth of
the sibling `## Compile` section -- deliberately a pointer to CLAY-VITE.md
for the full architecture/config picture, not a duplicate of it.

Docs only. npm test (lint + 456 tests) green.

Co-Authored-By: Claude Sonnet 5 <[email protected]>
@coveralls

coveralls commented Sep 15, 2026

Copy link
Copy Markdown

Coverage Status

coverage: 83.02%. remained the same — jordan/document-vite-in-readme into master

@jjpaulino jjpaulino self-assigned this Sep 15, 2026
@jjpaulino
jjpaulino merged commit 0865f5e into master Sep 15, 2026
6 checks passed
@jjpaulino
jjpaulino deleted the jordan/document-vite-in-readme branch September 15, 2026 19:13
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.

2 participants