Closed
Conversation
- Fix typos: "ouput" → "output", "regognizes" → "recognizes", "beyoud" → "beyond", "descison" → "decision", "cauious" → "cautious"
- Simplify wording: remove unnecessary words like "flexibility and", "currently", "practically"
- Improve grammar: fix subject-verb agreement ("Cache are" → "Caching is")
- Clarify explanations: rework awkward phrases for better readability
- Maintain technical accuracy while making text more concise
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
- Move CLI usage patterns from separate file into Getting Started - Remove standalone "CLI Options" file (too minimal, only 3 lines) - Reorder: put "Configuring Cache" before "Task Orchestration" - Cache concepts are referenced in orchestration - Logical progression: define tasks → cache them → orchestrate them - Update all cross-references to reflect new numbering New structure: 1. Getting Started (now includes CLI usage) 2. Defining Tasks 3. Task Orchestration (was 4) 4. Configuring Cache (was 5) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Change "script" to "command" in Task Orchestration example for consistency - Fix "inputs" to "outputs" in Configuring Cache example to match the comment about saving dist files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
yyx990803
reviewed
Nov 17, 2025
| @@ -0,0 +1,82 @@ | |||
| # Getting Started | |||
|
|
|||
| Vite is designed to work out of the box with zero configuration. Simply run `vite run <script>` to execute any script defined in your `package.json` file. | |||
There was a problem hiding this comment.
We need some intro to explain what it is, what problem it solves, and what it is similar to.
yyx990803
reviewed
Nov 17, 2025
| ``` | ||
|
|
||
| The first time you run `vite run lint`, Vite Task will execute it just like `npm run lint`: | ||
|
|
There was a problem hiding this comment.
I'd add a info box:
What's the difference between vite run lint and vite lint?
vite run lintis invoking the Vite task runner. It runs thelintscript defined underscriptsinpackage.json.vite lintis invoking Vite'slintcommand that performs the actual linting.
Collaborator
There was a problem hiding this comment.
Built-in commands like cargo lint or cargo fmt are written without run, so I don’t think they’re a good example for vite run.
More abstractly, how about using an example like vite run hello with "hello": "echo hello" instead?
Collaborator
|
Like oxlint and oxfmt, it might be necessary to provide a JSON Schema and build the documentation around that assumption. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive documentation for Vite Task
This PR adds detailed documentation for Vite Task, covering: