docs(readme): rebuild the landing page (FR-26112) - #125
Merged
Conversation
Applies the structure now used by the iOS and Android SDKs: product header with a live npm and licence badge, a capability summary, then install, quick start, documentation, example and support. The page previously went from peer dependencies straight to documentation links, with no requirements, no install command for the SDK itself and no code. It also carried a botched find-and-replace - "complex integration scenarReact Native" - and listed the example app as "A [Embedded] example projects". The API Reference entry is omitted because this repo has no api.md; that gap is tracked separately. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Every other mobile SDK ships an API reference; this repo did not, and the sidebar linked a page that never existed. Documents all nineteen symbols exported from src/index.tsx - the wrapper component, the useAuth hook and its state shape, every bridge method with its signature, and the Entitlement, FronteggConstants and FronteggLoginError types, including the stable login error codes. Restores the sidebar entry and the documentation row on the landing page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
The landing page had no install step and no code
README.mdis a symlink todocs/README.md, so one file serves both the GitHub landing page and react-native-guide.frontegg.com. It opened with peer dependencies — without ever giving the install command for the SDK itself — then listed documentation links and stopped. No requirements, no configuration, no snippet.Now reads: what it is → install → quick start → documentation → example → support. Same structure as iOS#316 and Android#280, with React Native's own content.
@frontegg/react-nativefirst, then the peer dependencies, with requirements stated inline: RN 0.63+, iOS 14+, Android API 26+ with JDK 17 and AGP 7.4+, and the extra iOS 15+ needed for passkeys.FronteggWrapperanduseAuth.Two errors fixed:
Deliberate omission: the documentation table has no API Reference row, because this repo has no
api.md. Every other mobile SDK ships one. #123 removes the dead sidebar link that pointed at the missing page; writing the page itself is content work worth doing separately.Step 2 of the native setup deliberately defers to the Setup guide rather than reproducing it — it is the one genuinely per-platform part, and duplicating it here would create two copies to keep in sync.
🤖 Generated with Claude Code