Skip to content

Add CLAUDE.md with codebase architecture and dev workflow guidance#2

Merged
Zekiog merged 1 commit into
mainfrom
claude/claude-md-docs-ub8q6h
Jun 15, 2026
Merged

Add CLAUDE.md with codebase architecture and dev workflow guidance#2
Zekiog merged 1 commit into
mainfrom
claude/claude-md-docs-ub8q6h

Conversation

@Zekiog

@Zekiog Zekiog commented Jun 15, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a CLAUDE.md at the repo root to orient future AI assistants (and developers) working in this codebase.

The doc focuses on the "big picture" that requires reading multiple files to grasp, and is honest about the current scaffold/stub state of the project:

  • Repo layout — root is marketing/metadata; the real app lives in A_ID/ (React frontend + FastAPI backend).
  • Frontend (A_ID/frontend/) — CRA + React 19 + Tailwind + framer-motion + react-i18next. Public marketing site (App.js) and admin SPA (src/admin/) split via routes.js. Mocked auth in useAuth.js. i18n details (7 languages, RTL Arabic, locales served from public/locales/). Design tokens in tailwind.config.js.
  • Backend (A_ID/backend/) — FastAPI + MongoDB stub with only a Hello World route; notes the ignored FastAPI(prefix="/api") gotcha.
  • Dependency files — clarifies which of the three requirements.txt is actually used, and that the Supabase/litellm/.env.example path is unimplemented.
  • Commands — frontend (yarn) and backend (uvicorn/pytest) dev/build/test, including single-test invocation.
  • Container startup & CI — flags that scripts/update-and-start.sh targets the hosted container and that the Azure/Node CI workflows don't match the actual app.

Test plan

  • Documentation only — no code changes.

https://claude.ai/code/session_0124mY2CkBteqc8UBAPKpr4R


Generated by Claude Code

Summary by CodeRabbit

  • Chores
    • Updated repository documentation for development guidance.

@vercel

vercel Bot commented Jun 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
a-identity-z Ready Ready Preview, Comment Jun 15, 2026 1:11pm

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4ae99a3d-f6fb-4136-a293-0ab4fc253d74

📥 Commits

Reviewing files that changed from the base of the PR and between f036159 and 815387c.

📒 Files selected for processing (1)
  • CLAUDE.md

Walkthrough

Adds CLAUDE.md, a new documentation file providing Claude Code with repository-level guidance. It covers the repository layout, frontend/admin and backend separation, authoritative dependency files, local and container run/build/test commands, CI/deployment workflow notes, and frontend coding and i18n conventions.

Changes

Repository Guidance Document

Layer / File(s) Summary
CLAUDE.md guidance document
CLAUDE.md
Introduces 87-line documentation covering architecture overview, frontend/backend separation (with mocked auth notes), authoritative dependency file selection, local and container run commands, CI/deployment workflow behavior, and frontend i18n conventions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A scroll of wisdom, freshly penned,
Where Claude may learn from start to end —
The frontend speaks, the backend stubs,
Commands and paths, no ifs or buts.
🐇 Hop along, the docs are done!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding CLAUDE.md documentation with codebase architecture and development workflow guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/claude-md-docs-ub8q6h

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@Zekiog Zekiog marked this pull request as ready for review June 15, 2026 13:16
@Zekiog Zekiog merged commit d2880bd into main Jun 15, 2026
5 checks passed
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.

3 participants