Skip to content

Document the UI component library and usage in docs/components #69

@mikewheeleer

Description

@mikewheeleer

Description

The docs/components folder only has ContractDetail.md and EmptyState.md, leaving most shared components undocumented. Add usage docs for MilestonesList, ContractSummary, ReputationProfile, ActionPanel, FormField, and SafeBoundary with props tables and examples. This makes the design system approachable for new contributors building escrow flows.

Requirements and context

  • Scoped to TalentTrust Talenttrust-Frontend (Next.js App Router + TS + Tailwind). Align with milestone/contract/reputation flows and the backend API.
  • Each doc includes purpose, props, usage snippet, and accessibility notes.
  • Cross-link docs to the relevant pages under src/app.
  • Must be accessible (WCAG 2.1 AA), responsive, tested, and documented. Concrete acceptance criteria: every listed component has a doc with a props table.

Suggested execution

  • Fork the repo and create a branch:
    • git checkout -b docs/component-library
  • Implement changes:
    • docs/components/MilestonesList.md (real or new)
    • Tests: src/components/__tests__/MilestonesList.test.tsx (Jest + React Testing Library)
    • Docs: docs/components/ComponentLibrary.md
    • Ensure keyboard nav, focus states, ARIA, color-contrast, and responsive breakpoints

Test and commit

  • Run: npm test, npm run lint, npm run build
  • Cover edge cases (loading, empty, error, no-wallet, slow network, small screens)
  • Include screenshots/notes and a11y check results in the PR

Example commit message

docs(ui): document core component library

Guidelines

  • Accessible (WCAG 2.1 AA), responsive, keyboard-navigable
  • Minimum 95% coverage on new/changed component logic
  • Clear documentation
  • Timeframe: 96 hours from assignment

Metadata

Metadata

Assignees

No one assigned

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions