docs: harmonize onboarding and contribution guidance - #422
Conversation
There was a problem hiding this comment.
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.mdto 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.
Deploying ui with
|
| Latest commit: |
a2f1148
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://89792846.ui-6d0.pages.dev |
| Branch Preview URL: | https://harmonize-instructions.ui-6d0.pages.dev |
|
@garrity-miepub please review and push... low risk and better docs. |
There was a problem hiding this comment.
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).
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
Validation
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.