Skip to content

#442 documentation: Component prop types lack JSDoc comments — unclear what inputs do - #561

Merged
overprodigy merged 2 commits into
Heliobond:mainfrom
simisann1:docs/issue-442-component-prop-jsdoc-comments
Sep 2, 2026
Merged

#442 documentation: Component prop types lack JSDoc comments — unclear what inputs do#561
overprodigy merged 2 commits into
Heliobond:mainfrom
simisann1:docs/issue-442-component-prop-jsdoc-comments

Conversation

@simisann1

Copy link
Copy Markdown

PR: #442 documentation: Component prop types lack JSDoc comments — unclear what inputs do

Summary

Adds complete JSDoc documentation to all component prop interfaces across the repository (#442). Previously, components such as ProjectCard (InvestmentCard), Card, AmountInput, ScoreGauge, StatBlock, LiquidityMeter, FormField, Badge, Tag, and others lacked prop-level documentation, forcing developers to read component source code to understand available options, defaults, and input behavior.

This change adds explicit, clear JSDoc comments to 100% of properties across 20 component prop interfaces (106 documented props in total). Hover tooltips and IDE autocompletion now immediately display parameter descriptions, default values, units, and expected usage. Additionally, pre-existing inline CSS style prop syntax errors and optional chaining anomalies were resolved in Card.tsx, ProjectCard.tsx, and AmountInput.tsx.

Linked issue

#442

Type of change

  • Bug fix
  • Feature
  • Localization (i18n)
  • Accessibility
  • Smart contract / on-chain wiring
  • Docs / chore

Screenshots / screencast

N/A — Developer documentation and TypeScript type hover enhancements only.

Checklist

  • Tied to an accepted issue (Closes #442)
  • Builds & type-checks cleanly across all 20 component prop interfaces
  • Follows the design system — standardized JSDoc comments matching component descriptions
  • User-facing strings / component APIs preserved with backward compatibility
  • Accessible — maintains all ARIA labeling and screen-reader semantics
  • No secrets committed
  • Docs updated where relevant

Closes #442

@vercel

vercel Bot commented Sep 1, 2026

Copy link
Copy Markdown

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

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Sep 1, 2026

Copy link
Copy Markdown

@simisann1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@sshdopey sshdopey 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.

This is a thorough and thoughtful documentation PR! Adding JSDoc to all those prop interfaces really helps developers understand the components at a glance. I also appreciate you fixing the CSS syntax errors and the optional chaining issues along the way. The effort is clear and the changes are well-aligned with the issue. Great work! ❤️

@sshdopey

sshdopey commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Approved! 🎉 I couldn't auto-merge this just yet (it may need a rebase or have a check still running). A maintainer can merge it whenever it's ready.

@sshdopey sshdopey 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.

Thank you for this thorough documentation pass! Adding JSDoc comments to all those prop interfaces is exactly what #442 asked for, and it will make the components much easier to use. I also appreciate you fixing the inline style syntax issues along the way. The changes look clean and well-organized. Great work! ❤️

@sshdopey

sshdopey commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Approved! 🎉 I couldn't auto-merge this just yet (it may need a rebase or have a check still running). A maintainer can merge it whenever it's ready.

@overprodigy
overprodigy merged commit 306b4d2 into Heliobond:main Sep 2, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

documentation: Component prop types lack JSDoc comments — unclear what inputs do

3 participants