docs: fundamentals section - #705
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds the initial “Fundamentals” documentation section for React Native Enriched HTML and introduces an interactive, in-browser example system for the docs site by wiring React Native components to react-native-web.
Changes:
- Added new Fundamentals pages (Getting started, Core concepts, HTML tags reference, and “Your first editor” walkthrough).
- Introduced an
InteractiveExamplecomponent (preview/code tabs + reset) and a first runnable example (FirstEditor.tsx). - Updated the docs build to support interactive RN examples via a
react-native-webwebpack alias, plus added required dependencies/loaders.
Reviewed changes
Copilot reviewed 11 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/yarn.lock | Updates lockfile for new docs dependencies (react-native(-web), raw-loader, etc.). |
| docs/src/theme/MDXComponents.js | Registers InteractiveExample as an available MDX component. |
| docs/src/examples/FirstEditor.tsx | Adds the first runnable interactive example used in Fundamentals docs. |
| docs/src/components/InteractiveExample/styles.module.css | Styles for the interactive example container, tabs, and preview/code layout. |
| docs/src/components/InteractiveExample/index.tsx | Implements interactive example preview/code tabs with a reset mechanism. |
| docs/package.json | Adds dependencies needed to render RN examples in the docs site and raw source loading. |
| docs/docusaurus.config.js | Adds a small plugin to alias react-native to react-native-web for the docs webpack build. |
| docs/docs/fundamentals/your-first-editor.mdx | New “Your first editor” page including a live interactive example embed. |
| docs/docs/fundamentals/your-first-editor.md | Removes the old placeholder page in favor of the new MDX version. |
| docs/docs/fundamentals/html-format-and-supported-tags.md | Fills in the supported-tags reference content and conflict/blocking rules. |
| docs/docs/fundamentals/getting-started.md | Replaces placeholder with Getting Started content (installation, prerequisites, etc.). |
| docs/docs/fundamentals/core-concepts.md | Replaces placeholder with Core Concepts content (uncontrolled model, HTML source of truth, etc.). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
hejsztynx
marked this pull request as ready for review
July 17, 2026 10:06
exploIF
reviewed
Jul 17, 2026
exploIF
reviewed
Aug 7, 2026
exploIF
left a comment
Collaborator
There was a problem hiding this comment.
Looks very promising, great job
Co-authored-by: Igor Furgała <74370735+exploIF@users.noreply.github.com>
szydlovsky
reviewed
Aug 10, 2026
Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>
Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>
szydlovsky
approved these changes
Aug 10, 2026
exploIF
approved these changes
Aug 11, 2026
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.
Summary
First section of the docs -
FundamentalsAdded a
react-native-webplugin, to allow interactive examplesConfigured ESLint, so it checks the files in the
docs- we want to keep the code of interactive examples clean