docs: add comprehensive CLAUDE.md for AI assistants#2
Conversation
- Document complete project architecture and tech stack - Add detailed codebase structure with file descriptions - Include development workflows and git conventions - Provide key patterns (multi-layer sentiment, service layer, etc.) - Document all 12 database tables with relationships - List all 30+ API endpoints across 8 routers - Add testing guidelines with fixtures and examples - Include deployment procedures for dev and production - Provide common tasks (adding endpoints, models, tasks, components) - Add troubleshooting guide with common issues and solutions - Reference all important configuration and documentation files This comprehensive guide will help AI assistants understand the codebase structure, conventions, and workflows for effective collaboration on the European News Intelligence Hub project.
WalkthroughA new comprehensive CLAUDE.md guide is added, documenting the EU Intelligence Hub project architecture, development workflows, conventions, database schema, API structure, testing guidelines, deployment procedures, and common operational tasks for AI assistants. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
CLAUDE.md (4)
116-116: Specify language for code blocks to enable syntax highlighting.Several code blocks are missing language identifiers. Update these blocks for consistency and to enable proper syntax highlighting:
- Line 116: Repository structure diagram (use
textor plain)- Line 786: SQL relationships diagram (use
text)- Lines 1522, 1544, 1556, 1598: Error output blocks (use
textor appropriate language)Example fix:
-``` +```text Repository structure or error message -``` +```Also applies to: 786-786, 1522-1522, 1544-1544, 1556-1556, 1598-1598
1687-1694: Wrap bare URLs in markdown link format.Lines 1690-1694 contain bare URLs that should use markdown link syntax for consistency and better accessibility.
Apply this diff:
**External Resources**: -- **FastAPI Docs**: https://fastapi.tiangolo.com/ -- **SQLAlchemy Docs**: https://docs.sqlalchemy.org/ -- **Celery Docs**: https://docs.celeryq.dev/ -- **React Docs**: https://react.dev/ -- **pgvector Docs**: https://github.com/pgvector/pgvector +- **FastAPI Docs**: [https://fastapi.tiangolo.com/](https://fastapi.tiangolo.com/) +- **SQLAlchemy Docs**: [https://docs.sqlalchemy.org/](https://docs.sqlalchemy.org/) +- **Celery Docs**: [https://docs.celeryq.dev/](https://docs.celeryq.dev/) +- **React Docs**: [https://react.dev/](https://react.dev/) +- **pgvector Docs**: [https://github.com/pgvector/pgvector](https://github.com/pgvector/pgvector)
325-348: Git workflow section is well-documented, consider adding branch validation note.The git workflow section (lines 325-348) is comprehensive and includes the specific claude/ branch prefix. Consider adding a brief note about verifying the current branch before pushing to avoid accidents, though this is a minor enhancement.
1698-1759: Summary for AI Assistants section is excellent; consider cross-referencing it earlier.The "Summary for AI Assistants" section (lines 1698-1759) provides clear, actionable DO/DON'T guidance tailored to the audience. Consider adding a note in the Table of Contents or introduction directing readers to this section early, so AI assistants understand expectations before diving into details.
Optional enhancement - add to Table of Contents (around line 12):
## Table of Contents +**For AI Assistants**: See section 12 [Summary for AI Assistants](#summary-for-ai-assistants) for quick guidance on working with this codebase. + 1. [Project Overview](#1-project-overview)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CLAUDE.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CLAUDE.md
116-116: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
786-786: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1196-1196: Bare URL used
(MD034, no-bare-urls)
1197-1197: Bare URL used
(MD034, no-bare-urls)
1198-1198: Bare URL used
(MD034, no-bare-urls)
1522-1522: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1544-1544: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1556-1556: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1598-1598: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
1687-1687: Bare URL used
(MD034, no-bare-urls)
1690-1690: Bare URL used
(MD034, no-bare-urls)
1691-1691: Bare URL used
(MD034, no-bare-urls)
1692-1692: Bare URL used
(MD034, no-bare-urls)
1693-1693: Bare URL used
(MD034, no-bare-urls)
1694-1694: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
CLAUDE.md (1)
1-10: Strong foundational documentation for AI assistants.This is a comprehensive and well-structured guide that effectively documents the EU Intelligence Hub codebase for AI assistant collaboration. The document successfully covers architecture, workflows, patterns, schema, API design, testing, deployment, and troubleshooting in clear, practical language.
The use of specific examples (code snippets, shell commands, API requests/responses) makes the guide immediately actionable. The "Summary for AI Assistants" section (lines 1698-1759) with explicit DO/DON'T guidance is particularly valuable.
2 participants
This comprehensive guide will help AI assistants understand the codebase structure, conventions, and workflows for effective collaboration on the European News Intelligence Hub project.
Summary by CodeRabbit
Note: This release contains no user-facing changes.