Description
The README includes project setup instructions and feature information, but it does not explain the purpose of the major directories in the repository.
Adding a Project Directory Guide section will help new contributors quickly understand where different parts of the project are located and where they should make changes.
Suggested Content
Provide a brief description for directories such as:
src/ – Main Next.js application source code.services/ai/ – FastAPI-based AI service.prisma/ – Database schema and migrations.docs/ – Project documentation.public/ – Static assets.seed-data/ – NCERT seed data and learner content..github/ – GitHub Actions workflows and repository automation.
Each description should be one or two concise sentences.
Benefits
- Makes the repository easier to navigate.
- Improves the onboarding experience for new contributors.
- Reduces confusion about where to implement changes.
- Enhances overall documentation quality.
Acceptance Criteria
- Add a new Project Directory Guide section to
README.md.
- Explain the purpose of the main project directories.
- Keep descriptions concise and beginner-friendly.
- Follow the existing README formatting and style.
Description
The README includes project setup instructions and feature information, but it does not explain the purpose of the major directories in the repository.
Adding a Project Directory Guide section will help new contributors quickly understand where different parts of the project are located and where they should make changes.
Suggested Content
Provide a brief description for directories such as:
src/– Main Next.js application source code.services/ai/– FastAPI-based AI service.prisma/– Database schema and migrations.docs/– Project documentation.public/– Static assets.seed-data/– NCERT seed data and learner content..github/– GitHub Actions workflows and repository automation.Each description should be one or two concise sentences.
Benefits
Acceptance Criteria
README.md.