Skip to content

Commit ea533de

Browse files
authored
docs: add Table of Contents to README (JhaSourav07#974)
## Description Fixes JhaSourav07#972 This PR adds a Table of Contents (TOC) to the main `README.md` to improve navigation for users and contributors. The TOC is placed at the top after the tagline and links to all major sections (Design Philosophy, Live Demo, Theme Presets, FAQ, etc.), mirroring the structure already used in `CONTRIBUTING.md`. ## Pillar - [ ] 🎨 Pillar 1 — New Theme Design - [ ] 📐 Pillar 2 — Geometric SVG Improvement - [ ] 🕐 Pillar 3 — Timezone Logic Optimization - [x] 🛠️ Other (Bug fix, refactoring, docs) ## Visual Preview N/A – Documentation change only. ## Checklist before requesting a review: - [x] I have read the `CONTRIBUTING.md` file. - [ ] I have tested these changes locally (`localhost:3000/api/streak?user=YOUR_USERNAME`). - [ ] I have run `npm run format` and `npm run lint` locally and resolved all errors (CI will fail otherwise). - [x] My commits follow the Conventional Commits format (e.g., `feat(themes): ...`, `fix(calculate): ...`). - [ ] I have updated `README.md` if I added a new theme or URL parameter. - [ ] I have started the repo. - [x] I have made sure that i have only one commit to merge in this PR. - [ ] The SVG output matches the CommitPulse "premium quality" aesthetic standard (no raw elements, smooth animations, correct fonts). - [ ] (Recommended) I joined the CommitPulse Discord community for contributor discussions, mentorship, and faster PR support.
2 parents 55b942c + 35ea720 commit ea533de

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,25 @@
1414

1515
> **Drop this into your GitHub profile README and stop being boring.**
1616
17+
## 📖 Table of Contents
18+
19+
- [Design Philosophy](#the-isometric-monolith--design-philosophy)
20+
- [Live Demo](#live-demo)
21+
- [Deep Customization](#deep-customization--url-parameters)
22+
- [Theme Presets](#theme-presets)
23+
- [Theme Preview Gallery](#theme-preview-gallery)
24+
- [Real-Time Accuracy](#real-time-accuracy--the-contribution-count-problem)
25+
- [Architecture & Tech Stack](#architecture--tech-stack)
26+
- [Self-Hosting](#self-hosting-in-4-steps)
27+
- [Automated Contributor Workflow](#automated-contributor-workflow)
28+
- [FAQ](#faq)
29+
- [Contributing](#contributing)
30+
- [License](#license)
31+
- [Themes](#themes)
32+
- [Contributors](#contributors)
33+
34+
---
35+
1736
![CommitPulse Live Demo](https://commitpulse.vercel.app/api/streak?user=jhasourav07&theme=neon)
1837

1938
[![Join CommitPulse Discord](https://img.shields.io/badge/Join-CommitPulse%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/Cb73bS79j)

0 commit comments

Comments
 (0)