Repository navigation
docs: refresh READMEs and add bilingual AI documentation - #9
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: 46ab494 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Deploying react-native-text-motion with
|
| 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 |
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Use the deployed documentation site as the library's main entry point instead of maintaining long duplicate API descriptions in four READMEs.
Changes
Validation
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.