Skip to content

[Documentation Update]: Adding a Project Structure Map #441

@siri-chandana-macha

Description

@siri-chandana-macha

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

Adding a clear structure map in the documentation to guide contributors on where specific files and folders are located and what they contain.

Suggested Change

For example:

Project Root
├── src/      # Core application files
│ ├── components/      # Reusable UI components
│ ├── services/      # API calls and business logic
│ ├── utils/      # Utility functions
│ └── index.js      # Main entry file
├── assets/      # Images, icons, and other static assets
├── config/      # Configuration files (e.g., env variables)
└── README.md      # Project overview and instructions

Rationale

This helps new contributors quickly understand the project layout and find files easily.

Urgency

High

Record

  • I agree to follow this project's Code of Conduct
  • I'm a GSSOC contributor
  • I want to work on this issue
  • I'm willing to provide further clarification or assistance if needed.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions