Skip to content

Copy package README to root and move the example UI - #1039

Merged
ianmacartney merged 4 commits into
mainfrom
ian/example-ui-layout
Oct 21, 2026
Merged

ianmacartney merged 4 commits into
mainfrom
ian/example-ui-layout

Conversation

@ianmacartney

@ianmacartney ianmacartney commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Supersedes #1032

Make the package documentation available at the repository root so links can target README.md and its headings before the packaging changes land. Keep packages/convex-helpers/README.md as a regular file for the existing build and npm package.

Move the frontend, HTML entrypoint, and Vite configuration into example-ui/, preserving the previous root example documentation in example-ui/README.md.

Backend-harness instructions also moved into the JS file out of README.

@ianmacartney
ianmacartney force-pushed the ian/example-ui-layout branch from 800deac to f08410b Compare October 21, 2026 23:15
@pkg-pr-new

pkg-pr-new Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/convex-helpers@1039

commit: a987df4

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed

Tip: Get a Slack DM when cubic finishes reviewing your PRs. Connect Slack

Re-trigger cubic

Comment thread README.md
Comment thread README.md Outdated
Comment thread vitest.config.mts
Comment thread README.md Outdated
@ianmacartney
ianmacartney merged commit a7856fd into main Oct 21, 2026
6 checks passed
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