docs: improve CLAUDE.md with accurate commands and architecture details#484
docs: improve CLAUDE.md with accurate commands and architecture details#484ruibrunocunha wants to merge 1 commit intoSynkraAI:mainfrom
Conversation
Remove nonexistent npm scripts (dev, build, dashboard), add monorepo workspace info, single test execution, TypeScript path aliases, git hooks behavior, core module architecture, and Prettier/ESLint style details. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Someone is attempting to deploy a commit to the Pedro Valério Lopez's projects Team on Vercel. A member of the Team first needs to authorize it. |
nikolasdehor
left a comment
There was a problem hiding this comment.
Nice effort consolidating the CLAUDE.md, @ruibrunocunha! A few observations:
Positives:
- Expanded project structure tree with all 4 workspace packages is really helpful
- Adding concrete
npmcommands that actually exist (removingnpm run dev/npm run buildwhich don't) prevents confusion - The core module architecture table (14 categories) is a great addition
- Git hooks section (lint-staged, IDS registry) documents behavior that trips up new contributors
- TypeScript path alias docs (
@synkra/aios-core) — good to have
Concerns:
-
Removes
<!-- FRAMEWORK-OWNED -->comment markers — The current CLAUDE.md uses these markers to distinguish sections the installer generates vs sections safe to customize. Removing them meansnpx aios-core installmay overwrite these changes or fail to merge correctly. Consider preserving the markers. -
Removes Language Configuration section — This section was framework-owned (generated by installer). Removing it could break the installer's ability to detect and update language config on
npx aios-core install. -
Removes the Error Handling pattern — The
try/catchtemplate withlogger.error+error instanceof Errorcheck is referenced by agent personas as the project standard. Worth keeping as a compact one-liner example at least. -
Semantic-release mapping is incomplete — The commit section now shows
feat → minor,fix → patch,perf → patch,breaking → major, but the original also documenteddocs:,test:,chore:,refactor:which are commonly used in this repo. Newer contributors won't know what types are valid. -
Quality Gates section removed — The pre-push checklist (
lint→typecheck→test) is gone. While the individual commands exist in the new "Comandos" section, the explicit "all these must pass before push" gate is useful context.
Overall a solid improvement — the expanded structure tree and real commands alone justify the PR. If you address items 1-2 (framework markers + language section), this would be ready to merge.
|
Tradução para pt-BR do review acima: Bom trabalho consolidando o CLAUDE.md, @ruibrunocunha! Algumas observações: Pontos positivos:
Preocupações:
No geral uma boa melhoria — se resolver os itens 1-2 (marcadores + seção de idioma), ficaria pronto pra merge. |
Summary
dev,build, dashboard section) that would mislead Claude CodeTest plan
package.json🤖 Generated with Claude Code