Skip to content

[Other]: Adding a Project Structure Map in the Documentation #261

@siri-chandana-macha

Description

@siri-chandana-macha

What would you like to share?

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

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

Additional information

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

Checklist

  • I have checked the existing issues.
  • I follow Contributing Guidelines of this project.
  • I am a IWOC'24 contributor.

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions