Skip to content

docs: add Task Runner user documentation#763

Merged
branchseer merged 12 commits intomainfrom
03-10-docs_add_vite-task_user_documentation
Mar 10, 2026
Merged

docs: add Task Runner user documentation#763
branchseer merged 12 commits intomainfrom
03-10-docs_add_vite-task_user_documentation

Conversation

@branchseer
Copy link
Copy Markdown
Member

@branchseer branchseer commented Mar 10, 2026

Summary

  • Add 5 new documentation pages for the task runner under /vite/guide/task/:
    • Getting Started — overview, running scripts, caching intro, task definitions, dependencies, monorepo usage
    • Running Tasks — package selection, compound commands, nested vp run, execution summary
    • Caching — how caching works, when it's enabled, automatic file tracking, environment variables, cache sharing
    • CLI Referencevp run usage, options, filter patterns, vp cache clean
    • Config Referencerun.cache, run.tasks, and all per-task options
  • Update VitePress sidebar and nav configuration

Test plan

  • Verify deploy preview renders all 5 pages correctly
  • Check all cross-page links resolve
  • Verify ASCII diagrams render properly in code blocks

🤖 Generated with Claude Code

@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 10, 2026

Deploy Preview for viteplus-staging canceled.

Name Link
🔨 Latest commit 3d25a57
🔍 Latest deploy log https://app.netlify.com/projects/viteplus-staging/deploys/69b02b1f90713300084eb3bd

Copy link
Copy Markdown
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@branchseer branchseer marked this pull request as ready for review March 10, 2026 09:56
@branchseer branchseer marked this pull request as draft March 10, 2026 10:37
branchseer and others added 9 commits March 10, 2026 18:37
Add guide pages (getting-started, running-tasks, caching, cli) and
config reference page for the task runner.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move docs/config/task.md to docs/vite/guide/task/config.md so the
Config sidebar link works within the /vite/guide/ base. Update all
cross-references to use relative paths and fix stale features.md links.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add "When Is Caching Enabled?" section to caching page with full
resolution flowchart (CLI flags → workspace config → per-task config).
Add --cache/--no-cache flags to CLI options table. Update overview to
mention pnpm run similarity and single-package/monorepo support.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Rewrite caching defaults section with correct priority ordering
- Add over-fingerprinting and environment variables sections
- Add output file caching limitation note
- Move interactive task selector to CLI page
- Simplify filter docs with pnpm compatibility mention
- Remove concurrency section and sensitive values info
- Rephrase nested vp run and fix CLI usage syntax

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Rename "Monorepo Setup" to "Running Across Packages"
- Rename "Task Specifier" to "Task Argument" with lead-in sentence
- Update info box to link to "When Is Caching Enabled?" instead of config
- Use package.json scripts in compound commands and cache sharing examples
- Note that script caching must be explicitly enabled
- Use third-party tool (webpack) in environment variables example

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@branchseer branchseer force-pushed the 03-10-docs_add_vite-task_user_documentation branch from de59c1a to 25bf31c Compare March 10, 2026 10:38
@branchseer branchseer marked this pull request as ready for review March 10, 2026 11:11
@branchseer branchseer merged commit 77322a0 into main Mar 10, 2026
22 checks passed
Copy link
Copy Markdown
Member Author

Merge activity

@branchseer branchseer deleted the 03-10-docs_add_vite-task_user_documentation branch March 10, 2026 14:51
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