Skip to content

Improve Folder Structure Display in README #46

Description

@anjanakri

Problem

The current folder structure section in the README is difficult to read because the tree is rendered as a single wrapped line instead of a clear hierarchical structure.

Current rendering:

  • Folder hierarchy is not visually distinguishable.
  • Level relationships are hard to understand.
  • New contributors may find it difficult to navigate the repository structure.

Proposed Solution

Display the folder structure using a properly formatted code block and provide brief descriptions for the main directories.

This will:

  • Improve readability.
  • Make the project structure easier to understand.
  • Enhance onboarding for new contributors.

Additional Context

Current README screenshot attached for reference.

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions