Skip to content

docs: harmonize onboarding and contribution guidance - #422

Open
horner wants to merge 3 commits into
mainfrom
harmonize-instructions
Open

docs: harmonize onboarding and contribution guidance#422
horner wants to merge 3 commits into
mainfrom
harmonize-instructions

Conversation

@horner

@horner horner commented Sep 5, 2026

Copy link
Copy Markdown
Member

Why

GitHub, npm, and Storybook were telling separate onboarding stories. Developers and agents also lacked a clear path from evaluating existing components to contributing a reusable addition upstream.

Changes

  • Make README.md the canonical introduction, rendered by a thin Storybook MDX wrapper.
  • Lead with consistent, inclusive browser interactions and explain incremental use in non-React applications.
  • Connect installation to agent setup and the actual instruction rules.
  • Restore See It In Action with a linked screenshot of the real dashboard; Storybook resolves the image locally.
  • Introduce component comparisons and composition guidance without claiming the catalog is complete.
  • Consolidate contributor setup and release guidance in CONTRIBUTING.md; clearly label AGGrid references as legacy maintenance.
  • Define the alternatives audit, contribution-ready implementation, exact-commit submodule workflow, linked upstream/consumer PRs, and required rationale and evidence.
  • Have agent Rule 14 delegate to that workflow rather than duplicate it, preserving approval requirements.

Validation

  • Passed: pnpm lint.
  • Passed: pnpm format:fix in an isolated source copy to avoid unrelated rewrites; Prettier checks on all changed Markdown/MDX files and git diff --check.
  • Passed: Storybook MDX compilation, local browser rendering, desktop/mobile sizing, section anchors, and linked story IDs.
  • Passed: dashboard thumbnail loading, responsive sizing, and destination checks.
  • Passed: npm pack --dry-run --ignore-scripts includes the README and agent installer/rules.
  • Passed: installer smoke test verifies both instruction outputs and repeat-install idempotency.
  • Blocked: pnpm typecheck reports 11 errors in untouched CollabStatus, CustomizableDashboard, and RichEditor files: missing yjs, y-protocols, @dnd-kit packages, and @kerebron/extension-yjs, plus an implicit-any error in collisionDetection.
  • Full unit and visual-regression suites were not run for this documentation-only change.

Publication Notes

The public thumbnail URL becomes available after Storybook deployment. npm shows the updated README with the next package release; this does not add automatic AI PR review or a merge gate.

Existing eSheet submodule changes and unrelated untracked directories are excluded.

Copilot AI lite review requested due to automatic review settings September 5, 2026 22:06

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

This PR harmonizes onboarding and contribution guidance by making README.md the canonical introduction and reusing it across GitHub, npm, and Storybook, while updating contributor and agent documentation to point to the same upstream workflows.

Changes:

  • Replaced the long Storybook Introduction MDX content with a thin wrapper that renders README.md (with a local dashboard thumbnail swap for Storybook).
  • Rewrote README.md to focus on consistent/inclusive UX guidance, incremental adoption (including non-React pages), and clear paths to Storybook exploration and contribution.
  • Consolidated contributor workflow and release guidance in CONTRIBUTING.md, and updated agent Rule 14 to delegate to that workflow.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

File Description
src/Introduction.mdx Renders the repo README.md in Storybook to keep onboarding content single-source.
README.md New canonical onboarding narrative + links for exploration, agent setup, and contribution.
CONTRIBUTING.md Adds documentation ownership guidance and expands contributor/release workflow details.
agent/mieweb-ui.instructions.md Updates Rule 14 to point to the upstream contribution workflow instead of duplicating it.

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

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 5, 2026

Copy link
Copy Markdown

Deploying ui with  Cloudflare Pages  Cloudflare Pages

Latest commit: a2f1148
Status: ✅  Deploy successful!
Preview URL: https://89792846.ui-6d0.pages.dev
Branch Preview URL: https://harmonize-instructions.ui-6d0.pages.dev

View logs

Copilot AI review requested due to automatic review settings September 5, 2026 22:17

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

Copilot reviewed 6 out of 7 changed files in this pull request and generated no new comments.

@horner

horner commented Sep 5, 2026

Copy link
Copy Markdown
Member Author

@garrity-miepub please review and push... low risk and better docs.

Copilot AI review requested due to automatic review settings September 5, 2026 22: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

Copilot reviewed 7 out of 8 changed files in this pull request and generated no new comments.

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

README.md:128

  • The ThemeToggle example uses a static label ("Dark mode") while toggling both directions; this is confusing in docs and for assistive tech because the button text/label doesn’t reflect the action that will occur. Consider making the visible label reflect the next action, and avoid aria-label on a text-labeled button (aria-pressed is sufficient).

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.

2 participants