Skip to content

docs: add codebase analysis docs and update CLAUDE.md#7

Open
alexandrewavelet wants to merge 1 commit into
Altered-Community:mainfrom
alexandrewavelet:docs/codebase
Open

docs: add codebase analysis docs and update CLAUDE.md#7
alexandrewavelet wants to merge 1 commit into
Altered-Community:mainfrom
alexandrewavelet:docs/codebase

Conversation

@alexandrewavelet
Copy link
Copy Markdown
Collaborator

Summary

  • Adds docs/codebase/ with 7 analysis documents (architecture, stack, conventions, integrations, testing, structure, concerns) to give Claude and contributors a full picture of the codebase
  • Updates CLAUDE.md to reference the new docs directory with a navigation table
  • Adds .idea/ and .envrc to .gitignore

Test plan

  • Confirm all 7 docs are present under docs/codebase/
  • Confirm CLAUDE.md links resolve correctly

🤖 Generated with Claude Code

- Add docs/codebase/ with 7 analysis documents covering architecture,
  stack, conventions, integrations, testing, structure, and concerns
- Update CLAUDE.md to reference the new docs directory

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@alexandrewavelet
Copy link
Copy Markdown
Collaborator Author

à propos de cette PR:
à la base j'ai ajouté ces docs pour le travail avec Claude Code, et plus particulièrement pour le taf avec des outils type GSD/superpowers (ces fichiers ont d'ailleurs été créés avec GSD).
Est ce que vous pensez que c'est vraiment utile/est ce qu'on peut s'en passer?

Ce qui est pas mal avec ces docs c'est qu'elles peuvent aussi servir pour l'onboarding des nouveaux devs étant donné qu'elles expliquent la stack du repo. Mais en l'état c'est peut être trop indigeste pour être lu par des humains et mériterait peut être une réécriture si on veut partir avec cet angle.

Sinon on peut aussi discuter des fichiers au cas par cas, ils n'ont pas tous la même valeur:

  • Architecture (archi générale du projet) et concerns (potentiels problèmes dans le code) sont intéressants
  • stack, testing et conventions beaucoup moins

Qu'est ce que vous en pensez?

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