docs: add agent instructions and vmsan skill reference#80
Open
Jelloeater wants to merge 1 commit into
Open
Conversation
Add comprehensive documentation for AI agents and developers: - AGENTS.md: Critical build order, development commands, Go agent workflow, testing guidance, changeset requirements, architecture overview, and common mistakes to avoid. Essential for new contributors and AI agents working on the codebase. - SKILL.md: Complete vmsan CLI reference with 1100+ lines covering all commands, flags, workflows, examples, and best practices. Serves as comprehensive skill documentation for AI agents to properly use and recommend vmsan. - .gitignore: Remove AGENTS.md from ignore list to make it part of the repository for all contributors to benefit from standardized guidance. These files provide essential context for: - Correct build order (agent before CLI) - Non-standard tooling (oxlint/oxfmt instead of eslint/prettier) - PR requirements (changesets for non-exempt files) - CI workflow matching (lint → typecheck → build → test) - Complete CLI command reference with real-world examples Breaking changes: None Impact: Documentation only, no code changes
|
@Jelloeater is attempting to deploy a commit to the BitSong Team Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis PR adds comprehensive documentation for the vmsan Firecracker microVM toolkit. It introduces AGENTS.md for developer contributors covering build sequencing and architecture, and SKILL.md as a complete CLI reference with commands, workflows, and troubleshooting. A .gitignore line is removed to include the new agent guide. Changesvmsan documentation suite
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds project agent guidance and a comprehensive vmsan CLI skill reference document, and stops ignoring AGENTS.md so it can be tracked in the repo.
Changes:
- New
AGENTS.mdwith build, dev, testing, architecture, and release guidance. - New
SKILL.mdwith full vmsan CLI reference, workflows, and examples. - Removed
AGENTS.mdfrom.gitignoreso it can be committed.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| AGENTS.md | New contributor/agent guide describing build order, tooling, testing, and architecture. |
| SKILL.md | New comprehensive CLI reference for vmsan including commands, flags, workflows, and troubleshooting. |
| .gitignore | Removes AGENTS.md from ignore list to allow tracking the new file. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+615
to
+621
| | Policy | Description | | ||
| |----------------|--------------------------------------------------| | ||
| | `allow-all` | Allow all outbound connections (default) | | ||
| | `deny-all` | Block all outbound connections (air-gapped) | | ||
| | `allow-list` | Allow only specified domains/IPs | | ||
| | `deny-list` | Block specified domains/IPs | | ||
|
|
| vmsan exec --workdir /app "$VM_ID" npm install | ||
|
|
||
| # Create snapshot of clean state | ||
| SNAPSHOT=$(vmsan snapshot create --name "clean-install" "$VM_ID" --json | jq -r '.id') |
|
|
||
| | Flag | Description | | ||
| |-----------------------------|------------------------------------------------| | ||
| | `--runtime RUNTIME` | Runtime image: base, node22, node24, python3.13 | |
Comment on lines
+478
to
+484
| # Connect and run commands | ||
| vmsan connect vm-abc123def | ||
| # Inside VM: | ||
| $ whoami | ||
| $ pwd | ||
| $ ls -la | ||
| $ exit |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AGENTS.md (1)
71-82: 💤 Low valueConsider adding a language identifier to the code fence.
The architecture diagram is displayed in a fenced code block without a language identifier. Adding
textorplaintextwould satisfy the markdown linter and make the formatting explicit.📝 Suggested formatting improvement
-``` +```text bin/cli.ts CLI entry (citty) src/🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` around lines 71 - 82, Update the fenced code block that contains the directory listing starting with "bin/cli.ts CLI entry (citty)" to include a language identifier (e.g., add `text` or `plaintext` after the opening ```) so the markdown linter recognizes it as plain text and preserves formatting; ensure only the opening fence is modified (```text) and no other content in that block is changed.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@AGENTS.md`:
- Around line 71-82: Update the fenced code block that contains the directory
listing starting with "bin/cli.ts CLI entry (citty)" to include a
language identifier (e.g., add `text` or `plaintext` after the opening ```) so
the markdown linter recognizes it as plain text and preserves formatting; ensure
only the opening fence is modified (```text) and no other content in that block
is changed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 22062c31-53ef-4aa2-8c30-33af835fa652
📒 Files selected for processing (3)
.gitignoreAGENTS.mdSKILL.md
💤 Files with no reviewable changes (1)
- .gitignore
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
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 AI agents and developers:
AGENTS.md: Critical build order, development commands, Go agent workflow, testing guidance, changeset requirements, architecture overview, and common mistakes to avoid. Essential for new contributors and AI agents working on the codebase.
SKILL.md: Complete vmsan CLI reference with 1100+ lines covering all commands, flags, workflows, examples, and best practices. Serves as comprehensive skill documentation for AI agents to properly use and recommend vmsan.
.gitignore: Remove AGENTS.md from ignore list to make it part of the repository for all contributors to benefit from standardized guidance.
These files provide essential context for:
Breaking changes: None
Impact: Documentation only, no code changes
Summary by CodeRabbit