Skip to content

docs: refresh READMEs and add bilingual AI documentation - #9

Merged
saseungmin merged 4 commits into
mainfrom
codex/docs-ai
Nov 15, 2026
Merged

saseungmin merged 4 commits into
mainfrom
codex/docs-ai

Conversation

@saseungmin

@saseungmin saseungmin commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

Use the deployed documentation site as the library's main entry point instead of maintaining long duplicate API descriptions in four READMEs.

Changes

  • Restructure English/Korean repository and npm-package READMEs following the Swipe Deck / Gesture Image Viewer family: overview, features, production docs, examples, AI resources, install and concise usage.
  • Add matching AI pages and sidebar entries explaining llms.txt, llms-full.txt, per-page Markdown and a copyable API-grounded prompt.
  • Set Rspress siteOrigin to https://react-native-text-motion.pages.dev so generated AI indexes use canonical public URLs.
  • Update the package homepage and monorepo repository directory; include a patch changeset for publishing the package README/metadata update as 0.1.1.
  • Update documentation development/hosting instructions for the deployed site.

Validation

  • Documentation checks: 19 matching pages per language, 26 demos, navigation/links/public API coverage pass.
  • All 11 source-extraction tests, typecheck, lint, formatting and production docs build pass.
  • Verified generated English/Korean index/full text files and AI Markdown pages; canonical URLs are present and localhost links absent.
  • Browser-checked both AI pages; independent API/snippet/link/language review found no issues.
  • Existing native media and animation implementations are unaffected.

The existing production site renders in a normal browser. Scripted HTTP fetching from this environment returns Cloudflare 1010/403; no Cloudflare security settings were changed. The AI guide includes a paste/attach alternative when a tool cannot fetch the URLs.

This PR creates the next version PR after merge; it does not itself publish an npm version.

Preserved project context

Restore the original README product decisions in ROADMAP.md and ROADMAP.ko.md, with immutable source links. Preserve the original MVP, deferred API candidates, explicit design exclusions, performance checkpoint and next-focus text. All four READMEs and both AI guides link to this maintainer context. README cleanup therefore keeps the development direction discoverable instead of discarding it.

Verified the original scope/deferred/MVP sections are preserved verbatim in both languages; documentation checks and the production build pass.

The docs also expose a bilingual Getting Started → Roadmap page, linked from Overview and AI. It provides topic links to the canonical repository roadmap instead of duplicating detailed planning.

The live Project direction & roadmap discussion #10 is now registered in General and pinned. All bilingual READMEs, repository roadmap snapshots, AI guides and roadmap pages link to it for ongoing proposals and feedback.

@changeset-bot

changeset-bot Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 46ab494

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@react-native-motion-kit/text-motion Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Deploying react-native-text-motion with  Cloudflare Pages  Cloudflare Pages

Latest commit: 46ab494
Status: ✅  Deploy successful!
Preview URL: https://6064dbcd.react-native-text-motion.pages.dev
Branch Preview URL: https://codex-docs-ai.react-native-text-motion.pages.dev

View logs

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-15T09:00:21.529760Z 0563264 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@saseungmin
saseungmin merged commit c460a1c into main Nov 15, 2026
6 checks passed
@saseungmin
saseungmin deleted the codex/docs-ai branch November 15, 2026 09:37
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