Skip to content

fix(sheet): fix broken Sheet component and add missing component documentation pages - #1357

Open
satya-achanta-venkata wants to merge 9 commits into
developfrom
bugfix/missing-sheet-component-in-documentation
Open

fix(sheet): fix broken Sheet component and add missing component documentation pages#1357
satya-achanta-venkata wants to merge 9 commits into
developfrom
bugfix/missing-sheet-component-in-documentation

Conversation

@satya-achanta-venkata

@satya-achanta-venkata satya-achanta-venkata commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

This change: (check at least one)

  • Adds a new feature
  • Fixes a bug
  • Improves maintainability
  • Improves documentation
  • Is a release activity

Is this a breaking change? (check one)

  • Yes
  • No

Is the: (complete all)

  • Title of this pull request clear, concise, and indicative of the issue number it addresses, if any?
  • Test suite(s) passing?
  • Code coverage maximal?
  • Changeset added?

What does this change address?

Fixes #1089 — the Sheet component's docs page button did nothing when clicked.

While auditing the docs site for other gaps, we also found 4 additional components with Storybook stories but no documentation page: Checkbox group, Radio group, Popover, and Table. All 5 pages were confirmed missing on production (pharos.jstor.org returns 404 for each).

@changeset-bot

changeset-bot Bot commented Jul 25, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: b2ab6c6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@ithaka/pharos-site Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@satya-achanta-venkata satya-achanta-venkata changed the title fix(documentation): add documentation for missing components WIP - fix(documentation): add documentation for missing components Jul 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
packages/pharos/lib/index.js 1.05 MB (0%)

satya-achanta-venkata and others added 5 commits August 10, 2026 19:57
… on docs site

The docs site's initComponents.tsx registers Pharos component classes as
site-pharos-* custom elements. PharosSheet and PharosPopover were missing
from this list, so their custom elements were never defined, causing
clicking their trigger buttons to do nothing (fixes #1089).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a guidelines page for the Checkbox Group component, following the
established pattern (usage, best practices, content guidelines, variants,
states, and accessibility), and adds a Sidenav entry so the page is
reachable from the docs site navigation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a guidelines page for the Radio Group component, following the
established pattern (usage, best practices, content guidelines, variants,
states, and accessibility), and adds a Sidenav entry so the page is
reachable from the docs site navigation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a guidelines page for the Popover component and a Sidenav entry so the
page is reachable from the docs site navigation.

The example trigger uses the component's built-in data-popover-id trigger
mechanism rather than a manual onClick handler, since PharosPopover closes
itself on any document click that isn't on a registered trigger or the
popover itself — a manual onClick toggle would open the popover and then
have it immediately closed by that same click bubbling to document.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@satya-achanta-venkata satya-achanta-venkata changed the title WIP - fix(documentation): add documentation for missing components fix(sheet): fix broken Sheet component and add missing component documentation pages Aug 11, 2026
@satya-achanta-venkata
satya-achanta-venkata marked this pull request as ready for review August 11, 2026 00:27
@satya-achanta-venkata
satya-achanta-venkata requested a review from a team as a code owner August 11, 2026 00:27
@satya-achanta-venkata
satya-achanta-venkata requested review from daneah, jialin-he and lizlove and removed request for a team August 11, 2026 00:27
Adds a guidelines page for the Table component and a Sidenav entry so the
page is reachable from the docs site navigation.

Includes a changeset summarizing this PR's fixes and documentation
additions for @ithaka/pharos-site.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@satya-achanta-venkata
satya-achanta-venkata force-pushed the bugfix/missing-sheet-component-in-documentation branch from b6104f1 to e04ac1b Compare August 11, 2026 00:29

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.

Pull request overview

Adds missing Pharos Site documentation pages for several components and fixes the Sheet docs page interaction by ensuring overlay components are registered as custom elements on the docs site, addressing the missing/404 docs pages and #1089.

Changes:

  • Add new guidelines documentation pages for Sheet, Checkbox group, Radio group, Popover, and Table.
  • Add corresponding /components/* page entrypoints that export the new guideline pages.
  • Register PharosPopover and PharosSheet in the site’s custom element registration, and expose the new pages in the Sidenav.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/pharos-site/static/guidelines/table.docs.tsx New Table documentation page content and examples.
packages/pharos-site/static/guidelines/sheet.docs.tsx New Sheet documentation page, including an “Open sheet” example.
packages/pharos-site/static/guidelines/radio-group.docs.tsx New Radio group documentation page content and examples.
packages/pharos-site/static/guidelines/popover.docs.tsx New Popover documentation page content and example trigger/popover.
packages/pharos-site/static/guidelines/checkbox-group.docs.tsx New Checkbox group documentation page content and examples.
packages/pharos-site/src/pages/components/table/index.tsx Route entrypoint exporting the Table guideline page.
packages/pharos-site/src/pages/components/sheet/index.tsx Route entrypoint exporting the Sheet guideline page.
packages/pharos-site/src/pages/components/radio-group/index.tsx Route entrypoint exporting the Radio group guideline page.
packages/pharos-site/src/pages/components/popover/index.tsx Route entrypoint exporting the Popover guideline page.
packages/pharos-site/src/pages/components/checkbox-group/index.tsx Route entrypoint exporting the Checkbox group guideline page.
packages/pharos-site/src/components/Sidenav.tsx Adds new component links to the docs site navigation.
packages/pharos-site/initComponents.tsx Registers PharosPopover and PharosSheet custom elements for the site.
.changeset/tame-heroes-sneeze.md Changeset describing the site patch release for these docs fixes/additions.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sheet component is missing a documentation page

2 participants