Skip to content

docs(customization): Add documentation for view=punchcard feature - #8954

Open
ChetanSenta wants to merge 3 commits into
JhaSourav07:mainfrom
ChetanSenta:docs/document-punchcard-view
Open

docs(customization): Add documentation for view=punchcard feature#8954
ChetanSenta wants to merge 3 commits into
JhaSourav07:mainfrom
ChetanSenta:docs/document-punchcard-view

Conversation

@ChetanSenta

Copy link
Copy Markdown
Contributor

Description

Fixes #8953

Pillar

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

What this PR does

view=punchcard — a fully wired-up, dedicated isometric 24×7 commit-
timing chart with its own GitHub data fetch (fetchCommitPunchCard) —
had zero mentions anywhere in docs/customization.md. Added it to both
view table rows, an example, and a guard test asserting every real
view enum value gets a documentation mention going forward.

Checklist before requesting a review:

  • I have read the CONTRIBUTING.md file.
  • I have tested these changes locally.
  • I have run npm run format and npm run lint locally and resolved all errors.
  • My commits follow the Conventional Commits format.
  • I have made sure that I have only one commit to merge in this PR.

Copilot AI lite review requested due to automatic review settings August 7, 2026 10:24
@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

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

A member of the Team first needs to authorize it.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@retenta-bot

retenta-bot Bot commented Aug 7, 2026

Copy link
Copy Markdown

This PR addresses the lack of documentation for the view=punchcard feature by adding necessary details to the customization documentation. It's great to see this improvement, especially since it ensures that all view enum values are documented going forward. This aligns well with previous decisions to enhance visualizations like the Punch Card Heatmap, which also aimed to provide better insights into commit activity. Thank you for your contribution!

@retenta-bot retenta-bot Bot changed the title docs(customization): document view=punchcard — a fully-implemented view with zero prior documentation docs(customization): Add documentation for view=punchcard feature Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Size Report (Gzipped Sizes)

✨ No significant bundle size changes detected.

📊 Summary of Totals

Category PR Size Base Size Difference
Total JS 4998.89 KB 4998.89 KB 0 B
Total CSS 354.18 KB 354.18 KB 0 B

@Aamod007 Aamod007 added level:beginner Small changes Usually isolated fixes or simple UI/text updates. quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. type:docs Documentation changes, wikis, or README updates mentor:Aamod007 labels Aug 9, 2026

@Aamod007 Aamod007 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for documenting the new \�iew=punchcard\ feature! Keeping our customization parameter reference up-to-date is extremely helpful for our users. Approved!

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

Labels

gssoc:needs-rebase level:beginner Small changes Usually isolated fixes or simple UI/text updates. mentor:Aamod007 quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. type:docs Documentation changes, wikis, or README updates

Projects

None yet

4 participants