Skip to content

docs: add FAQ section to in-app documentation page#895

Merged
JhaSourav07 merged 1 commit into
JhaSourav07:mainfrom
prithivika2007:docs/add-faq-section
May 28, 2026
Merged

docs: add FAQ section to in-app documentation page#895
JhaSourav07 merged 1 commit into
JhaSourav07:mainfrom
prithivika2007:docs/add-faq-section

Conversation

@prithivika2007
Copy link
Copy Markdown
Contributor

@prithivika2007 prithivika2007 commented May 28, 2026

Description

Fixes #886

Pillar

  • 🎨 Pillar 1 — New Theme Design
  • 📐 Pillar 2 — Geometric SVG Improvement
  • 🕐 Pillar 3 — Timezone Logic Optimization
  • 🛠️ Other (Bug fix, refactoring, docs)

Visual Preview

Before

FAQ only existed in the README on GitHub — not accessible within the app itself.

After

image

Checklist before requesting a review:

  • 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).
  • 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.
  • 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.

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 28, 2026

@prithivika2007 is attempting to deploy a commit to the jhasourav07's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Copy Markdown

👋 Hey @prithivika2007, welcome to CommitPulse! 🎉

Thanks for opening your first pull request — this is a big deal and we appreciate the effort!

While you wait for a review, please double-check:

  • ✅ You've read the CONTRIBUTING.md checklist
  • npm run lint, npm run format, and npm run test all pass locally
  • ✅ Your PR has a visual preview if it touches any SVG output
  • 💬 You've joined our Discord for faster PR feedback

A maintainer will review your PR shortly. Hang tight! 🚀

@github-actions github-actions Bot added the type:docs Documentation changes, wikis, or README updates label May 28, 2026
@JhaSourav07 JhaSourav07 added GSSoC 2026 level:beginner Small changes Usually isolated fixes or simple UI/text updates. quality:exceptional Outstanding contribution with exceptional implementation quality, testing. mentor:Aamod007 labels May 28, 2026
@JhaSourav07 JhaSourav07 merged commit db2525c into JhaSourav07:main May 28, 2026
10 of 11 checks passed
@github-actions
Copy link
Copy Markdown

🎉 Congratulations @prithivika2007! Your PR has been successfully merged. 🚀

Thank you for contributing to CommitPulse. Your work helps us build a better tool for the community.

⚠️ Important for GSSoC Contributors:
You are strictly advised to join our Discord Server as it is mandatory for all GSSoC participants. All important announcements, point claims, and community discussions happen there.

Keep building! 💻✨

@prithivika2007 prithivika2007 deleted the docs/add-faq-section branch May 29, 2026 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSSoC 2026 level:beginner Small changes Usually isolated fixes or simple UI/text updates. mentor:Aamod007 quality:exceptional Outstanding contribution with exceptional implementation quality, testing. type:docs Documentation changes, wikis, or README updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add FAQ section to the in-app Documentation page

3 participants