Skip to content

Commit a16cc65

Browse files
docs: add FAQ section to in-app documentation page
1 parent 9b64cab commit a16cc65

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
@@ -439,6 +439,50 @@ export default function DocumentationPage() {
439439
</div>
440440
</Panel>
441441
</section>
442+
<section className="mb-8">
443+
<Panel
444+
eyebrow="FAQ"
445+
title="Frequently Asked Questions"
446+
description="Quick answers to the most common questions from the CommitPulse community."
447+
>
448+
<div className="space-y-3">
449+
{[
450+
{
451+
q: 'How do I change the accent color of my badge?',
452+
a: 'Add &accent=ff6b35 to your URL with any hex color (no # needed). This overrides the theme accent color.',
453+
},
454+
{
455+
q: 'Can I use a custom font?',
456+
a: 'Yes — use the &font= parameter. Pass any Google Font name (e.g. &font=Fira+Code). If left blank, the theme default is used.',
457+
},
458+
{
459+
q: 'Why does my badge show NOT FOUND?',
460+
a: 'This means the GitHub username does not exist or has no public contribution data. Double-check your username spelling.',
461+
},
462+
{
463+
q: 'How do I embed the badge in my README?',
464+
a: 'Copy the markdown snippet from the homepage and paste it into your GitHub profile README. The badge renders automatically.',
465+
},
466+
{
467+
q: 'Can I preview my badge before adding it to my README?',
468+
a: 'Yes! Enter your GitHub username on the homepage to instantly preview your 3D contribution monolith before copying the link.',
469+
},
470+
{
471+
q: 'Which themes are available?',
472+
a: 'CommitPulse includes dark, neon, dracula, github, light, ocean, sunset, forest, rose, nord, synthwave, gruvbox and highcontrast. See the Theme Gallery above for previews.',
473+
},
474+
].map(({ q, a }) => (
475+
<div
476+
key={q}
477+
className="rounded-[1.25rem] border border-black/10 bg-gray-50 px-5 py-4 dark:border-white/8 dark:bg-black/35"
478+
>
479+
<p className="text-sm font-semibold text-black dark:text-white">{q}</p>
480+
<p className="mt-2 text-sm leading-7 text-gray-600 dark:text-white/60">{a}</p>
481+
</div>
482+
))}
483+
</div>
484+
</Panel>
485+
</section>
442486
</div>
443487
</main>
444488
);

0 commit comments

Comments
 (0)