Skip to content

Add Project Structure - #34

Open
dimpal-yadav wants to merge 1 commit into
Tanyasharma71:mainfrom
dimpal-yadav:Add-Project-Structure
Open

Add Project Structure#34
dimpal-yadav wants to merge 1 commit into
Tanyasharma71:mainfrom
dimpal-yadav:Add-Project-Structure

Conversation

@dimpal-yadav

Copy link
Copy Markdown
Contributor

📝 Pull Request Template

📄 Description

This PR adds a PROJECT_STRUCTURE.md file to the repository to clearly document the folder and file structure of PeaceBot AI.
It provides an overview of all main directories, files, and their purposes, making it easier for new contributors and developers to understand the project layout.

The documentation includes:

  • Root directory overview
  • Description of key components and modules
  • Instructions on running the project locally

🔗 Related Issues

Close #5


🖼️ Screenshots (if applicable)

Not applicable (documentation/text-only update)


🧩 Type of Change

  • 🐛 Bug Fix
  • ✨ New Feature
  • ⚡ Enhancement / Optimization
  • 🧰 Refactoring
  • 🧾 Documentation Update
  • 🔧 Other (please specify): ____________

✅ Checklist

  • I have added the PROJECT_STRUCTURE.md file
  • I have reviewed the documentation for clarity and correctness
  • My changes do not break any existing functionality
  • I have linked all relevant issues (if any)

💬 Additional Notes (Optional)

Adding this project structure file improves readability, maintainability, and onboarding for new contributors.

Signed-off-by: Dimpal Yadav <dimpal.yadav2912@gmail.com>

@AkhilHaroldPeter AkhilHaroldPeter left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey i think the folder structure is updated:
image


image

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.

Add Project Structure in README.md

2 participants