Skip to content

docs: improve README folder structure formatting#47

Open
anjanakri wants to merge 1 commit into
devweekends:mainfrom
anjanakri:improve-readme-structure
Open

docs: improve README folder structure formatting#47
anjanakri wants to merge 1 commit into
devweekends:mainfrom
anjanakri:improve-readme-structure

Conversation

@anjanakri

Copy link
Copy Markdown

Related Issue

Closes #46

Changes Made

  • Reformatted the folder structure section in the README using a proper code block.
  • Improved readability of the repository hierarchy.
  • Added concise descriptions for the main directories.
  • Prevented the folder tree from rendering as a wrapped single line.

Why

The previous folder structure was difficult to read because the tree formatting was not preserved, making it hard for contributors to understand the repository layout.

This update improves navigation and onboarding while keeping the structure concise and maintainable.

Before

  • Folder hierarchy was difficult to distinguish.
  • Tree structure wrapped across multiple lines.
  • Repository organization was not immediately clear.
image

After

  • Clear hierarchical folder tree.
  • Better readability on GitHub.
  • Easier for new contributors to understand the project structure.
image

Copilot AI review requested due to automatic review settings June 6, 2026 15:48

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the repository’s folder-structure documentation to reflect current organization and provide clearer descriptions for each directory.

Changes:

  • Reformatted the folder structure section into a fenced text block for readability
  • Refined directory descriptions (Pre-Requisites, Level 0/1, Common) to be more specific

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +86 to +92
├── Pre-Requisites/ # Basics of C++, Math, and Complexity
│ └── README.md
├── Level 0/ # Core DSA Patterns (Arrays, Strings, Hashmaps, Trees, Recursion...)
├── Level 1/ # Advanced DSA Topics organized week-wise (Week 01 - Week 16)
│ └── README.md
├── Common/ # Shared templates, utilities, and resources
└── README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve Folder Structure Display in README

2 participants