Skip to content

docs: Add CLAUDE.md and UNITY_CONTEXT.md for AI development guidance#11

Open
nkarkare wants to merge 1 commit intoprodfrom
feature/claude-md-documentation
Open

docs: Add CLAUDE.md and UNITY_CONTEXT.md for AI development guidance#11
nkarkare wants to merge 1 commit intoprodfrom
feature/claude-md-documentation

Conversation

@nkarkare
Copy link
Copy Markdown

@nkarkare nkarkare commented Jul 3, 2025

AI Development Documentation for Payment Gateway Integration

This PR adds documentation files to support AI-assisted development in Unity ERP's payment gateway module:

Files Added

  • CLAUDE.md: Payment gateway-specific development guide
  • UNITY_CONTEXT.md: Complete educational domain business context

Key Features

  • EaseBuzz payment processing for educational fee collection
  • Unity ERP ecosystem positioning and cross-module dependencies
  • Educational payment workflows and fee management integration

Benefits

  • Enables AI assistants to understand payment gateway integration in educational context
  • Provides business context for educational fee collection workflows
  • Supports Unity-specific payment processing development patterns

🤖 Generated with Claude Code Documentation System

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for integrating the EaseBuzz payment gateway with Frappe applications, covering architecture, features, security, and development guidance.
    • Introduced detailed business and architectural context documentation for the Unity ERP system, outlining educational domain workflows, compliance, integration points, and technical considerations.

- Add comprehensive CLAUDE.md with payment gateway integration context
- Add UNITY_CONTEXT.md with educational domain business context
- Include EaseBuzz payment processing for educational fee collection
- Provide Unity-specific development patterns for payment gateways
- Reference educational payment workflows and fee management

🤖 Generated with Claude Code (claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 3, 2025

Walkthrough

Two new documentation files, CLAUDE.md and UNITY_CONTEXT.md, have been added. CLAUDE.md provides technical and integration guidance for the EaseBuzz payment gateway app within Frappe applications, while UNITY_CONTEXT.md outlines the business context, architecture, and compliance requirements for the Unity ERP system tailored to educational institutions.

Changes

File(s) Change Summary
CLAUDE.md Added documentation detailing EaseBuzz payment gateway integration, architecture, and security.
UNITY_CONTEXT.md Added comprehensive business and technical context documentation for Unity ERP in education.

Poem

Two docs have hopped into the fold,
One for payments, clear and bold—
The other, Unity’s schoolyard tale,
With workflows mapped in every detail.
Rabbits love when docs appear,
For clarity grows, and code is clear!
🐇📚


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (4)
UNITY_CONTEXT.md (3)

22-24: Use a heading instead of bold text for the lifecycle flow.

Bold emphasis (**Lead Generation → … Alumni**) is triggering MD036 (“no-emphasis-as-heading”).
Convert this to a proper Markdown heading for consistency with the rest of the document.

-**Lead Generation → Student Applicant → Student → Program Enrollment → Alumni**
+#### Lead Generation → Student Applicant → Student → Program Enrollment → Alumni

160-162: Add the missing article “a”.

LanguageTool flags the phrase “using common admission process”.
Insert the article “a” for grammatical correctness.

-**Centralized Admissions**: Multiple schools using common admission process
+**Centralized Admissions**: Multiple schools using a common admission process

255-259: Replace hyphens with en dashes in numeric ranges.

Typographical nit: ranges such as “500-5000” and “50-500” should use an en dash (–) rather than a hyphen (-).

-**Student Population**: 500-5000 students per entity
-**Staff Size**: 50-500 employees depending on institution size
+**Student Population**: 500–5000 students per entity
+**Staff Size**: 50–500 employees depending on institution size
CLAUDE.md (1)

60-60: Clarify wording of document-event description.

“Processes settlement logs on save” reads awkwardly. Consider re-phrasing for clarity.

-**Easebuzz Settlement Log**: Processes settlement logs on save via `process_log` function
+**Easebuzz Settlement Log**: Processes settlement logs when the document is saved via the `process_log` function
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 109fccd and 73e5add.

📒 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)

CLAUDE.md

[uncategorized] ~60-~60: The preposition ‘to’ seems more likely in this position.
Context: ...lement Log**: Processes settlement logs on save via process_log function ## Dev...

(AI_HYDRA_LEO_REPLACE_ON_TO)

🪛 markdownlint-cli2 (0.17.2)
UNITY_CONTEXT.md

22-22: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (2)
UNITY_CONTEXT.md (1)

1-266: Overall document is comprehensive and well-structured.

The added business-context documentation significantly improves onboarding for new contributors working on education-domain features. Nice work.

CLAUDE.md (1)

1-137: Documentation looks solid.

The architecture, commands, and security guidance are clear and actionable.

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