docs: implement proper documentation #865
Merged
Conversation
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
boorad
requested changes
Dec 14, 2025
- Fix EOF line ending in .gitignore - Add react-native-nitro-modules to all installation instructions - Update performance claims from '58x' to 'hundreds of times faster' - Reframe JSI mentions to focus on Nitro Modules architecture - Add libsodium/xsalsa20 configuration documentation
- Change Simple Random Strings to suggest react-native-get-random-values for random-only use cases - Update comparison title from JSI to Nitro - Add benchmark philosophy note explaining comparison context
athexweb3
force-pushed
the
docs
branch
2 times, most recently
from
fa2cb0b to
536d9a3
Compare
Contributor
Author
|
added lib folder. you can check now |
- Add comprehensive 'Contributing' and 'Writing Documentation' guides to the website. - Update `CONTRIBUTING.md` with instructions for updating feature coverage. - Update [README.md](/README.md:0:0-0:0) with links to the new documentation guides. - Add theme-aware banner images to the Quick Start page. - Standardize documentation structure guidelines.
- Fix broken table formatting in 'What is RNQC?' introduction page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
docs: implement proper documentation website
Description
This PR introduces the official documentation website for react-native-quick-crypto.
The site is built with Next.js (App Router) and Fumadocs, providing a fast, modern, and searchable documentation experience.
Features
Modern stack
Built with Next.js 14 and Fumadocs.
Comprehensive API reference
Detailed documentation for all modules, including
Cipher,Hmac,PBKDF2,RSA,BLAKE3, and more.Practical guides
New guides covering real-world use cases:
Custom UI (Nitro-style)
Custom landing page, hero section, and responsive layout aligned with the Nitro docs design language.
Performance benchmarks
Visual performance benchmarks for the library.
Notes for Reviewers
This PR is fairly large and introduces a full documentation stack along with opinionated structure, wording, and examples.
Because of that, it may include:
A thorough review is highly appreciated, especially around:
Please feel free to be strict. Feedback, corrections, and suggestions are very welcome. The goal is to make these docs accurate, clear, and maintainable for the long term.
✅ Verification
bun run build)