Skip to content

Document direct CWMSTable data - #323

Draft
krowvin wants to merge 1 commit into
mainfrom
fix/cwmstable-direct-data-docs
Draft

Document direct CWMSTable data#323
krowvin wants to merge 1 commit into
mainfrom
fix/cwmstable-direct-data-docs

Conversation

@krowvin

@krowvin krowvin commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a rendered pre-fetched data example and document the CDA-compatible series shape
  • publish accurate optional CWMSTable prop types
  • dedupe shared React and TanStack Query peers during linked docs development
  • correct the stale SHB air-temperature TSID in the existing example

Why

CWMSTable already accepts inputTSValues, but the docs only mentioned the prop in the API table and the generated declaration exposed it as required any. That made direct data input hard to discover and easy to misuse. A linked Windows docs install also loaded duplicate peer instances until the docs build explicitly deduplicated them.

Validation

  • npx vitest run --maxWorkers=1 — 12 files, 44 tests passed
  • npm run build-lib
  • docs npm run build against the locally linked package
  • focused ESLint on both modified docs source files
  • Prettier check on every modified file
  • npm run check-changeset
  • desktop and mobile browser verification with no console errors
  • mobile page width verified with no document-level horizontal overflow

The repository-wide docs lint command still reports its existing baseline of 92 unrelated problems; the modified docs files pass focused lint.

Screenshots

Desktop

CWMSTable pre-fetched data example on desktop

Mobile

CWMSTable pre-fetched data example on mobile

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.

1 participant