Skip to content

Split CLAUDE.md into DEVELOPER_GUIDE.md (Issue #2978)#3019

Closed
Yuan9527-ai wants to merge 1 commit intorysweet:mainfrom
Yuan9527-ai:main
Closed

Split CLAUDE.md into DEVELOPER_GUIDE.md (Issue #2978)#3019
Yuan9527-ai wants to merge 1 commit intorysweet:mainfrom
Yuan9527-ai:main

Conversation

@Yuan9527-ai
Copy link

Fixes issue #2978

@github-actions
Copy link
Contributor

PR Triage Report

Risk: 🟢 Low | Priority: Normal | Recommendation: Needs revision before merge

Assessment

Thank you for contributing, @Yuan9527-ai! This PR adds a new DEVELOPER_GUIDE.md file to address issue #2978. The triage notes below are intended to help you improve the PR before it's reviewed for merge.

Passes:

  • ✅ GitGuardian security scan
  • ✅ Only adds documentation (no code changes, low blast radius)

Concerns requiring revision:

  1. Incomplete scope — Issue docs: CLAUDE.md conflates onboarding and reference documentation, creating cognitive overload #2978 asks to split CLAUDE.md so that human-developer content is separated from AI-agent configuration. This PR adds a new file but leaves CLAUDE.md unchanged. The intent is for CLAUDE.md to be trimmed (removing the human-developer sections that now live in DEVELOPER_GUIDE.md).

  2. Placeholder content — Several sections appear generic rather than reflecting the actual project:

    • from amplihack import Agent — there is no Agent class exported at the package top level
    • "Check the FAQ in the docs folder" — this FAQ does not exist yet
    • The learning path and usage examples don't match how amplihack actually works
  3. Branch naming — PR was opened from the main branch of your fork. Convention is to use a feature branch (e.g. docs/split-claude-md-2978). This isn't blocking, but it makes it harder to iterate on the PR.

Suggested next steps

  1. Review the existing CLAUDE.md content and identify sections intended for human developers vs AI agents.
  2. Move those human-developer sections into DEVELOPER_GUIDE.md with accurate, project-specific content.
  3. Trim CLAUDE.md to remove the migrated sections (keeping the AI-agent configuration).
  4. Replace placeholder examples with ones that actually reflect amplihack's API.

Labels applied: triage:complete triage:low-risk documentation triage:needs-review

Generated by PR Triage Agent ·

@rysweet
Copy link
Owner

rysweet commented Mar 10, 2026

not interested in ai driven docs prs

@rysweet rysweet closed this Mar 10, 2026
@github-actions github-actions bot mentioned this pull request Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants