Skip to content

docs: tell the ReadonlyView product story - #6

Merged
Cylop merged 13 commits into
mainfrom
docs/product-story-final
Sep 4, 2026
Merged

Cylop merged 13 commits into
mainfrom
docs/product-story-final

Conversation

@Cylop

@Cylop Cylop commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Reframe the README and website around the problem: expose live internal data without exposing mutation.
  • Add mental-model, use-case, decision-guide, and expanded API documentation.
  • Add tested SDK, registry, and plugin examples with owner liveness and consumer mutation rejection.
  • Add accessible website story, comparison, fit guidance, calls to action, and short-viewport keyboard navigation.
  • Add unpublished, channel-native launch drafts and long-form technical content under marketing/.
  • Improve npm keyword discoverability without adding dependencies or exports.

Verification

  • npm run release:check — 102 unit tests plus types, package, website, size, benchmark, and release checks
  • npm run test:browser — 28 passed locally across Chromium and Firefox; WebKit remains required in Linux CI
  • Product range has no src/ diff from the hardening base
  • npm package remains the intended seven files and excludes marketing/
  • Independent final delivery review: 0 Critical, 0 Important, 0 Minor

Delivery gate

This is a stacked PR based on fix/native-method-hardening so its diff contains communication work only. Do not retarget to main, merge, deploy, or post the marketing drafts until PR #5 is merged and @nipe-solutions/[email protected] plus npm latest = 2.0.1 are publicly verified.

Nothing in this PR publishes npm, deploys the website, or posts to social channels.

@vercel

vercel Bot commented Sep 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
readonly-view Ready Ready Preview Sep 4, 2026 11:30am UTC

@Cylop
Cylop force-pushed the docs/product-story-final branch from 763de73 to 578c6ef Compare September 4, 2026 11:17
Base automatically changed from fix/native-method-hardening to main September 4, 2026 11:18
@Cylop
Cylop force-pushed the docs/product-story-final branch from 578c6ef to 3f3f48e Compare September 4, 2026 11:18
@Cylop
Cylop merged commit 5941a8b into main Sep 4, 2026
2 of 3 checks passed

This branch was successfully deployed

1 active deployment
Preview — 3f3f48ec Deployed Sep 4, 2026 by vercel[bot]
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