docs(customization): Enhance documentation for missing view types in API - #8320
docs(customization): Enhance documentation for missing view types in API#8320ChetanSenta wants to merge 1 commit into
Conversation
…ssing radar/doughnut/pie/activity_graph/commit_clock
|
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. |
|
This pull request addresses the documentation gap by adding missing view types to the API reference, which is crucial for developers using the library. It's great to see thorough testing included to ensure all enum values are documented. This aligns well with our past decisions to enhance testing and validation in our API routes. Thank you for your contributions, and I look forward to your updates! |
📦 Next.js Bundle Size Report (Gzipped Sizes)✨ No significant bundle size changes detected. 📊 Summary of Totals
|
Aamod007
left a comment
There was a problem hiding this comment.
Documentation enhancement for missing view types plus validation test updates. CI failing, please fix.
Labels: level:beginner (2 files), quality:clean, type:docs, type:testing, mentor:Aamod007
Aamod007
left a comment
There was a problem hiding this comment.
Re-reviewing after noting the only CI failure is Vercel authorization (not code-related). All other checks (Format · Lint · Typecheck · Test, Production Build, CodeQL) pass. Approving — the Vercel deploy auth is a repo-level config issue, not a code problem.
Description
Fixes #8319
Pillar
What this PR does
lib/validations.ts'sviewenum has 13 real, fully-implemented values,each with a working route in
app/api/streak/route.ts. Bothviewparameter table rows in
docs/customization.md— the canonicalparameter reference — only documented 7-8 of them. 5 real views
(
radar,doughnut,pie,activity_graph,commit_clock) werecompletely undiscoverable from the docs. Added them to both tables, plus
a guard test asserting every real enum value gets a documentation mention.
Checklist before requesting a review:
CONTRIBUTING.mdfile.npm run formatandnpm run lintlocally and resolved all errors.