Skip to content

docs: enhance README for better navigation and contributor experience#603

Open
Rajith-14 wants to merge 2 commits into
Priyanshu-byte-coder:mainfrom
Rajith-14:docs/enhance-readme-issue-479
Open

docs: enhance README for better navigation and contributor experience#603
Rajith-14 wants to merge 2 commits into
Priyanshu-byte-coder:mainfrom
Rajith-14:docs/enhance-readme-issue-479

Conversation

@Rajith-14
Copy link
Copy Markdown

  • Add centered hero header with tagline and quick-links bar

  • Add explicit Table of Contents with anchor links

  • Add "Why DevTrack?" section with clearer value proposition

  • Reformat Roadmap as table with beginner/intermediate/advanced labels

  • Add Future Vision sub-section to Roadmap

  • Reformat Getting Started steps with bold headers for readability

  • Add footer with star CTA and live demo link

@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

@Rajith-14 is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts) labels May 22, 2026
@github-actions
Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Thanks for your first PR on DevTrack! 🎉

A maintainer will review it within 48 hours. While you wait:

  • Make sure CI is passing (type-check + lint)
  • Double-check the PR description is filled out and the issue is linked
  • Feel free to ask questions in Discussions if you need help

If you find DevTrack useful, a ⭐ star on the repo is always appreciated — it helps the project grow and attract more contributors!

Copy link
Copy Markdown
Owner

@Priyanshu-byte-coder Priyanshu-byte-coder left a comment

Choose a reason for hiding this comment

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

Two issues:

  1. Missing EOF newline on README.md — add \n after last line.
  2. Dynamic badge regression — this PR removes dynamic badges that were previously added (CI status, contributor count, etc.). Please restore those or keep them alongside any new additions.

@Priyanshu-byte-coder Priyanshu-byte-coder added the level:beginner GSSoC: Beginner difficulty (20 pts) label May 22, 2026
- Restore dynamic badges (Contributors, Last Commit, Open Issues) that were accidentally dropped in the last PR; kept alongside all existing static badges
- Fix missing newline at end of file to satisfy POSIX standards and linting rules
@Rajith-14
Copy link
Copy Markdown
Author

Two issues:

  1. Missing EOF newline on README.md — add \n after last line.
  2. Dynamic badge regression — this PR removes dynamic badges that were previously added (CI status, contributor count, etc.). Please restore those or keep them alongside any new additions.

Thanks for the review! I've addressed both issues:

Missing EOF newline — Added a trailing newline at the end of README.md after the closing tag to comply with POSIX conventions and pass lint checks.
Dynamic badge regression — Restored all dynamic badges (Contributors, Last Commit, Open Issues) alongside the existing static badges. No previous badges were removed.

Both fixes are included in the latest commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc26 GSSoC 2026 contribution level:beginner GSSoC: Beginner difficulty (20 pts) type:docs GSSoC type bonus: documentation (+5 pts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants