Add CLAUDE.md and .claude/ agent configuration - #367
Open
simple-agent-manager[bot] wants to merge 4 commits into
Open
Add CLAUDE.md and .claude/ agent configuration#367simple-agent-manager[bot] wants to merge 4 commits into
simple-agent-manager[bot] wants to merge 4 commits into
Conversation
Comprehensive project context for AI agents including: - Docusaurus 3 framework details and directory structure - Build/dev/preview commands and prebuild pipeline - Content conventions (frontmatter, MDX, sidebar config) - Style guide and CLI doc accuracy requirements - SAM integration guidance for ephemeral environments Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace reference to private repo path with functional description. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jordanstephens
approved these changes
Jun 1, 2026
lionello
requested changes
Jul 30, 2026
Comment on lines
+262
to
+283
| ### SAM Tool Usage | ||
|
|
||
| | Tool | When to Use | | ||
| |------|-------------| | ||
| | `update_task_status` | After completing milestones (e.g., "drafted new tutorial", "fixed broken links") | | ||
| | `expose_port` | When running `npm run start` (port 3000) so humans can preview the dev server | | ||
| | `create_idea` | When you discover doc improvements, missing content, or broken links during work | | ||
| | `search_messages` | To find context from prior conversations about doc changes | | ||
|
|
||
| ### Knowledge Graph | ||
|
|
||
| SAM maintains a persistent knowledge graph across sessions. Use it to preserve non-obvious context: | ||
|
|
||
| | Tool | When to Use | | ||
| |------|-------------| | ||
| | `add_knowledge` | Store observations about user preferences (entityType: `preference`), content conventions not in CLAUDE.md (entityType: `style`), architecture decisions (entityType: `context`), or project context like feature launches and deprecations (entityType: `context`) | | ||
| | `search_knowledge` | Before key decisions — e.g., search "ContentStyle" before writing docs, search "PlaygroundDeprecation" before referencing Playground | | ||
| | `update_knowledge` / `remove_knowledge` | Fix stale or incorrect observations | | ||
| | `confirm_knowledge` | When you verify an existing observation is still accurate | | ||
|
|
||
| Do NOT store: content derivable from the docs themselves, git history, ephemeral task details, or anything already in CLAUDE.md. | ||
|
|
Member
There was a problem hiding this comment.
Remove SAM specific text from generic CLAUDE.md
Member
There was a problem hiding this comment.
This could be renamed AGENTS.md to make other harnesses pick it up too.
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.
Summary
CLAUDE.mdwith project-specific conventions for AI agents working in the defang-docs repo.claude/settings.jsonwith basic project metadataDetails
The
CLAUDE.mddocuments:npm run start/buildcommands and the prebuild step that auto-generates CLI docs from the Go CLI source and ingests samplesexpose_portfor dev server preview,update_task_statusat milestones, verification discipline against actual CLI/Portal behaviorTest plan
🤖 Generated with Claude Code