Skip to content

Commit db2525c

Browse files
authored
docs: add FAQ section to in-app documentation page (JhaSourav07#895)
## Description Fixes JhaSourav07#886 ## Pillar - [ ] 🎨 Pillar 1 β€” New Theme Design - [ ] πŸ“ Pillar 2 β€” Geometric SVG Improvement - [ ] πŸ• Pillar 3 β€” Timezone Logic Optimization - [x] πŸ› οΈ Other (Bug fix, refactoring, docs) ## Visual Preview ### Before FAQ only existed in the README on GitHub β€” not accessible within the app itself. ### After <img width="1546" height="811" alt="image" src="https://github.com/user-attachments/assets/53dfeb4d-20dd-4fc2-9558-27adc4c159a9" /> ## Checklist before requesting a review: - [x] I have read the `CONTRIBUTING.md` file. - [x] I have tested these changes locally (`localhost:3000/api/streak?user=YOUR_USERNAME`). - [x] 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. - [x] 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). - [x] (Recommended) I joined the CommitPulse Discord community for contributor discussions, mentorship, and faster PR support.
2 parents aef52dd + a16cc65 commit db2525c

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

β€Žapp/documentation/page.tsxβ€Ž

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,50 @@ export default function DocumentationPage() {
459459
</div>
460460
</Panel>
461461
</section>
462+
<section className="mb-8">
463+
<Panel
464+
eyebrow="FAQ"
465+
title="Frequently Asked Questions"
466+
description="Quick answers to the most common questions from the CommitPulse community."
467+
>
468+
<div className="space-y-3">
469+
{[
470+
{
471+
q: 'How do I change the accent color of my badge?',
472+
a: 'Add &accent=ff6b35 to your URL with any hex color (no # needed). This overrides the theme accent color.',
473+
},
474+
{
475+
q: 'Can I use a custom font?',
476+
a: 'Yes β€” use the &font= parameter. Pass any Google Font name (e.g. &font=Fira+Code). If left blank, the theme default is used.',
477+
},
478+
{
479+
q: 'Why does my badge show NOT FOUND?',
480+
a: 'This means the GitHub username does not exist or has no public contribution data. Double-check your username spelling.',
481+
},
482+
{
483+
q: 'How do I embed the badge in my README?',
484+
a: 'Copy the markdown snippet from the homepage and paste it into your GitHub profile README. The badge renders automatically.',
485+
},
486+
{
487+
q: 'Can I preview my badge before adding it to my README?',
488+
a: 'Yes! Enter your GitHub username on the homepage to instantly preview your 3D contribution monolith before copying the link.',
489+
},
490+
{
491+
q: 'Which themes are available?',
492+
a: 'CommitPulse includes dark, neon, dracula, github, light, ocean, sunset, forest, rose, nord, synthwave, gruvbox and highcontrast. See the Theme Gallery above for previews.',
493+
},
494+
].map(({ q, a }) => (
495+
<div
496+
key={q}
497+
className="rounded-[1.25rem] border border-black/10 bg-gray-50 px-5 py-4 dark:border-white/8 dark:bg-black/35"
498+
>
499+
<p className="text-sm font-semibold text-black dark:text-white">{q}</p>
500+
<p className="mt-2 text-sm leading-7 text-gray-600 dark:text-white/60">{a}</p>
501+
</div>
502+
))}
503+
</div>
504+
</Panel>
505+
</section>
462506
</div>
463507
</main>
464508
);

0 commit comments

Comments
Β (0)