Skip to content

docs: fundamentals section#705

Open
hejsztynx wants to merge 11 commits into
feat/docsfrom
@ksienkiewicz/docs-fundamentals
Open

docs: fundamentals section#705
hejsztynx wants to merge 11 commits into
feat/docsfrom
@ksienkiewicz/docs-fundamentals

Conversation

@hejsztynx

@hejsztynx hejsztynx commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

First section of the docs - Fundamentals

Added a react-native-web plugin, to allow interactive examples

Configured ESLint, so it checks the files in the docs - we want to keep the code of interactive examples clean

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 InteractiveExample component (preview/code tabs + reset) and a first runnable example (FirstEditor.tsx).
  • Updated the docs build to support interactive RN examples via a react-native-web webpack 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.

Comment thread docs/docs/fundamentals/getting-started.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread docs/docs/fundamentals/getting-started.md Outdated
Comment thread docs/docs/fundamentals/your-first-editor.mdx
Comment thread docs/docs/fundamentals/your-first-editor.mdx Outdated
Comment thread docs/docs/fundamentals/your-first-editor.mdx Outdated
Comment thread docs/docs/fundamentals/your-first-editor.mdx Outdated
Comment thread docs/docs/fundamentals/your-first-editor.mdx
hejsztynx and others added 3 commits July 16, 2026 19:48
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Comment thread docs/docs/fundamentals/html-format-and-supported-tags.md Outdated
Comment thread docs/docs/fundamentals/html-format-and-supported-tags.md Outdated
Comment thread docs/package.json Outdated
"react": "19.1.1",
"react-dom": "19.1.1"
"react-dom": "19.1.1",
"react-native": "0.83.0",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not the newest version of RN?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also bumped react-native-enriched-html

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

react and react-dom should be at least 19.2.3 when we are using react-native: 0.86: https://react-native-community.github.io/upgrade-helper/?from=0.83.0&to=0.86.0

But now I'm wondering whether we should touch those dependencies at all, especially if this setup was generated by the marketing team. We could simply use React Native 0.82, which is compatible with React 19.1.1, and leave the rest of the dependencies as they are.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@szydlovsky @exploIF some thoughts?

Comment thread docs/docs/fundamentals/html-format-and-supported-tags.md Outdated
hejsztynx and others added 4 commits July 17, 2026 09:52
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Comment thread docs/docs/fundamentals/core-concepts.md Outdated
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
@hejsztynx
hejsztynx marked this pull request as ready for review July 17, 2026 10:06
@hejsztynx
hejsztynx requested review from exploIF and szydlovsky July 17, 2026 10:06
Comment thread docs/package.json
"react-dom": "19.1.1",
"react-native": "0.86.0",
"react-native-enriched-html": "1.0.1",
"react-native-web": "0.21.2"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why it's needed? react-native-enriched-html web should work without react-native-web dependency

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.

4 participants