Skip to content

[DOCS] Add project file structure to README.md #79

@ReshmithaTc

Description

@ReshmithaTc

Description:

Currently, the README.md does not include the project’s file structure. Adding a clear file structure section would help contributors and new users quickly understand the organization of the project.

Proposed Solution:

  • Add a "Project Structure" section in the README.md.
  • Provide a tree-like view of the directories and key files using a code block.

Benefits:

  • Makes it easier for new contributors to navigate the project.
  • Improves documentation clarity and usability.
  • Saves time by reducing confusion about file locations.
  • Enhances overall project maintainability and professionalism

As a part of GSSoC'25 , I would like to work on this issue. Could you please assign it to me @harshendram

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions