Skip to content

docs: improve agent repository guidance#1670

Merged
fengmk2 merged 3 commits into
voidzero-dev:mainfrom
jong-kyung:feat/agent-guide
May 24, 2026
Merged

docs: improve agent repository guidance#1670
fengmk2 merged 3 commits into
voidzero-dev:mainfrom
jong-kyung:feat/agent-guide

Conversation

@jong-kyung
Copy link
Copy Markdown
Collaborator

@jong-kyung jong-kyung commented May 24, 2026

Summary

  • Add a root AGENTS.md as the primary AI-agent guide for the vite-plus repository
  • Use oxc-resolver's AGENTS.md as a structural reference for project overview, architecture, workflow, conventions, testing, debugging, and agent tips
  • Convert CLAUDE.md into a compatibility pointer to AGENTS.md

Details

This updates the root agent guidance so AI coding assistants can orient around Vite+ as a unified web toolchain rather than a Vite Task-only codebase.

The new guide covers:

  • project overview and key technologies
  • repo architecture map
  • where to start for common change areas
  • vp built-ins vs vp run / run.tasks
  • setup, build, validation, and snap-test guidance
  • Rust and TypeScript convention references
  • debugging anchors and common agent pitfalls

CLAUDE.md now delegates to AGENTS.md to keep one source of truth.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 24, 2026

Deploy Preview for viteplus-preview canceled.

Name Link
🔨 Latest commit f821e80
🔍 Latest deploy log https://app.netlify.com/projects/viteplus-preview/deploys/6a12ea624b275a00086affbd

@jong-kyung jong-kyung requested a review from fengmk2 May 24, 2026 10:10
@jong-kyung jong-kyung self-assigned this May 24, 2026
@fengmk2 fengmk2 merged commit 8255acb into voidzero-dev:main May 24, 2026
27 checks passed
@fengmk2
Copy link
Copy Markdown
Member

fengmk2 commented May 24, 2026

@jong-kyung vp check fails
image

@jong-kyung
Copy link
Copy Markdown
Collaborator Author

@jong-kyung vp check fails

@fengmk2 Sorry about that. I’ll take a look and submit a follow-up PR to fix it. 😭

fengmk2 pushed a commit that referenced this pull request May 24, 2026
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