Skip to content

Docs: Phase P2.13 package and example READMEs#98

Merged
dbanksdesign merged 3 commits into
mainfrom
docs/readmes-p2-13
Jun 17, 2026
Merged

Docs: Phase P2.13 package and example READMEs#98
dbanksdesign merged 3 commits into
mainfrom
docs/readmes-p2-13

Conversation

@dbanksdesign

Copy link
Copy Markdown
Collaborator

Summary

  • Add npm landing-page READMEs for all published packages that were missing them (typestyles, @typestyles/vite, @typestyles/astro, @typestyles/migrate, @typestyles/props, @typestyles/open-props, @typestyles/build-runner, @typestyles/eslint-plugin)
  • Add READMEs for every example app and shared library, plus a new examples/README.md index with contributor guidance
  • Expand docs/README.md with accurate site layout, LiveDemo authoring, and a doc-page-to-example map
  • Cross-link high-traffic guides (getting-started, zero-runtime, vite-plugin, etc.) to runnable example READMEs on GitHub
  • Update root README.md with package and example indexes; mark P2.13 complete in IMPROVEMENTS.md

Test plan

  • README links resolve within the monorepo (relative paths)
  • Example run commands match root package.json scripts
  • Prettier/lint-staged passed on commit
  • Spot-check a few GitHub README links after merge

Made with Cursor

dbanksdesign and others added 3 commits June 17, 2026 10:57
Ship npm landing-page READMEs for every published integration package,
an examples index with contributor guidance, and a doc-to-example map
so guides link to runnable monorepo apps.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@dbanksdesign dbanksdesign merged commit e17b8a0 into main Jun 17, 2026
6 checks passed
@dbanksdesign dbanksdesign deleted the docs/readmes-p2-13 branch June 17, 2026 18:02
@github-actions github-actions Bot mentioned this pull request Jul 4, 2026
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