docs: add agent guidance#203
Open
mtojek wants to merge 8 commits into
Open
Conversation
…holder - README.md: restore clickable Markdown link to docs/architecture.md - docs/architecture.md: replace [separator] with actual CLI separator (--) - docs/agent-guide.md: replace duplicated architecture/runtime/proxy/audit/ TLS/backend/privilege sections with cross-references to architecture.md, keeping only agent-specific workflow, change guidance, testing, troubleshooting, and failure catalog
- architecture.md: add missing log/ and nsjail_manager/nsjail/ to repo map - architecture.md: document that domain wildcard matches deeper subdomains - architecture.md: document that trailing path wildcard matches multiple segments - architecture.md: clarify CONNECT handshake requests are not audited - agent-guide.md: note make ci also fails due to missing test target
Agents reading AGENTS.md are already at the right file. Documenting that CLAUDE.md symlinks here or that .agents/docs exists is meta-information about the file layout that does not help agents do actual work.
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
1 participant
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.
Summary
AGENTS.mdentrypoint for autonomous agents working in Boundary.docs/:docs/agent-guide.mdfor agent workflow, testing, troubleshooting, and failure modes.docs/architecture.mdfor the human-facing runtime and architecture overview.docs/e2e-tests.mdfor host-mutating Linux sudo e2e test guidance.CLAUDE.md -> AGENTS.md.agents/docs -> ../docse2e_tests/AGENTS.md -> ../docs/e2e-tests.md.cursorrulesintentionally omitted.Testing
ARCHITECTURE.mdor.claude/docs/BOUNDARY_AGENT_GUIDE.mdentrypoints.git diff --checkgit diff --cached --checkmake unit-testPlanning notes
The chosen doc structure intentionally stays consolidated instead of mirroring the larger
coder/coderdoc tree one-to-one. Canonical content lives indocs/; root and tool-specific files are short entrypoints only.This avoids duplicating the same architecture, testing, and e2e guidance across multiple Markdown files while preserving the entrypoints that remain in the repository.
Generated by Coder Agents.