docs: Add CLAUDE.md and UNITY_CONTEXT.md for AI development guidance#11
docs: Add CLAUDE.md and UNITY_CONTEXT.md for AI development guidance#11
Conversation
- Add comprehensive CLAUDE.md with Unity ERP foundation module context - Add UNITY_CONTEXT.md with educational domain business context - Include core educational DocTypes and workflow foundations - Provide Unity-specific development patterns for base education functionality - Reference foundational data models that Unity ERP extends 🤖 Generated with Claude Code (claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughTwo new documentation files, Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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 (3)
UNITY_CONTEXT.md (3)
161-161: Add the missing determiner for smoother reading- - **Centralized Admissions**: Multiple schools using common admission process + - **Centralized Admissions**: Multiple schools using a common admission process
192-192: Clarify the phrase “as per regulations”- - **Data Retention**: Educational record retention as per regulations + - **Data Retention**: Educational record retention as per applicable regulationsThis small tweak avoids the slightly awkward “as per regulations” construction and makes the policy reference clearer.
256-257: Prefer an en dash for numeric ranges- - **Student Population**: 500-5000 students per entity - - **Staff Size**: 50-500 employees depending on institution size + - **Student Population**: 500–5,000 students per entity + - **Staff Size**: 50–500 employees, depending on institution sizePurely cosmetic, but it matches common technical-writing conventions and improves readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CLAUDE.md(1 hunks)UNITY_CONTEXT.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
UNITY_CONTEXT.md
[uncategorized] ~161-~161: You might be missing the article “a” here.
Context: ...ed Admissions**: Multiple schools using common admission process - Staff Mobility:...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~192-~192: Did you mean “regulation”? If following ‘per’, nouns are often singular.
Context: ...**: Educational record retention as per regulations - Anonymization: Research and analy...
(CONFUSION_OF_NNS_NN_UN)
[typographical] ~256-~256: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...itution Scale - Student Population: 500-5000 students per entity - Staff Size: 5...
(HYPHEN_TO_EN)
[typographical] ~257-~257: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...0 students per entity - Staff Size: 50-500 employees depending on institution size...
(HYPHEN_TO_EN)
🔇 Additional comments (1)
CLAUDE.md (1)
1-220: Documentation looks solidThe structure, coverage, and cross-references are clear. No content or formatting issues stood out.
1 participant
AI Development Documentation for Core Education Module
This PR adds documentation files to support AI-assisted development in Unity ERP's core education module:
Files Added
Key Features
Benefits
🤖 Generated with Claude Code Documentation System
Summary by CodeRabbit