Skip to content

Add CLAUDE.md and .claude/ agent configuration#367

Open
simple-agent-manager[bot] wants to merge 4 commits into
mainfrom
claude/agent-config-setup
Open

Add CLAUDE.md and .claude/ agent configuration#367
simple-agent-manager[bot] wants to merge 4 commits into
mainfrom
claude/agent-config-setup

Conversation

@simple-agent-manager
Copy link
Copy Markdown

Summary

  • Adds a comprehensive CLAUDE.md with project-specific conventions for AI agents working in the defang-docs repo
  • Creates .claude/settings.json with basic project metadata
  • Covers Docusaurus 3 framework details, directory structure, build pipeline, content conventions, style guide, CLI doc accuracy requirements, and SAM integration guidance

Details

The CLAUDE.md documents:

  • Project overview: Docusaurus 3, Tailwind CSS, Algolia search
  • Directory structure: All key directories and their purposes
  • Build pipeline: npm run start/build commands and the prebuild step that auto-generates CLI docs from the Go CLI source and ingests samples
  • Content conventions: Frontmatter format, file naming (kebab-case), sidebar configuration (autogenerated from directories), MDX component usage, internal linking patterns
  • Style guide: Second person, present tense, prerequisites sections, CLI accuracy requirements
  • CI/CD: PR test-deploy and main branch deploy workflows
  • SAM integration: Ephemeral environment awareness, expose_port for dev server preview, update_task_status at milestones, verification discipline against actual CLI/Portal behavior

Test plan

  • Review CLAUDE.md content for accuracy against current project conventions
  • Verify build/dev commands are correct
  • Confirm directory structure matches reality
  • Check that SAM guidance is appropriate

🤖 Generated with Claude Code

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>
@simple-agent-manager simple-agent-manager Bot requested a review from a team as a code owner April 17, 2026 09:48
raphaeltm and others added 3 commits April 17, 2026 10:44
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>
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.

1 participant