Skip to content

[ENHANCEMENT] Modularize Beginner Training Material into QUICKSTART.md #11

@Vedant4102004

Description

@Vedant4102004

📌 Problem Description
The root README.md currently contains the entire end-to-end, multi-step Git interactive instruction guide. While incredibly thorough, placing this long tutorial directly on the landing dashboard makes the entry point dense and hard to scan. Since a dedicated QUICKSTART.md file already exists in the file tree, we should split this content cleanly.

💡 Proposed Solution
Refactor the repository's layout architecture:

  • Migrate the granular 7-step onboarding tutorial blocks explicitly out of README.md and move them cleanly into QUICKSTART.md.
  • Keep a clean, high-level summary on the main README.md landing page with an elegant, high-visibility call-to-action button or link pointing users straight to QUICKSTART.md to begin their onboarding.

🛠️ Technical Domain & Directory Focus
Target Files: README.md and QUICKSTART.md
Concepts Covered: Repository Architecture, Content Modularization, Technical Writing Clarity.

📋 Acceptance Criteria

  • The landing page README.md becomes short, crisp, and readable at a single glance.
  • QUICKSTART.md becomes the dedicated home for the 7-step technical training workflow tutorial.

Hey @Adez017 can you assign this issue to me i am nsoc contributor.

Metadata

Metadata

Assignees

Type

No type
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