Skip to content

📃 Documentation Update: Adding a Project Structure Map #164

@siri-chandana-macha

Description

@siri-chandana-macha

Describe the documentation update.

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

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

Why is this needed?

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

Additional context

Note: please kindly assign this issue under gssoc-extd and hacktoberfest-accepted and level

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions