Skip to content

docs: project configuration#712

Open
hejsztynx wants to merge 8 commits into
@ksienkiewicz/docs-fundamentalsfrom
@ksienkiewicz/feat-docs-project-configuration
Open

docs: project configuration#712
hejsztynx wants to merge 8 commits into
@ksienkiewicz/docs-fundamentalsfrom
@ksienkiewicz/feat-docs-project-configuration

Conversation

@hejsztynx

@hejsztynx hejsztynx commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • wired up ESLint and TS, as we now have interactive examples' code visible directly in the docs.
  • react-native-enriched-html is now linked locally.
  • as the library is resolved locally, the CI build scripts need its dependencies installed,so the root node_modules has become available now in the CI scripts.

Copilot AI review requested due to automatic review settings July 20, 2026 09:44
@hejsztynx
hejsztynx changed the base branch from main to feat/docs July 20, 2026 09:45
@hejsztynx
hejsztynx marked this pull request as draft July 20, 2026 09:47

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

This PR updates the docs setup to support interactive, TypeScript-based code examples rendered directly in Docusaurus, and wires the repo scripts to typecheck the docs package as part of the overall workflow.

Changes:

  • Add a live “InteractiveExample” component (preview + source) and a first editor example used in the Fundamentals docs.
  • Add docs TypeScript configuration and include docs in the root typecheck script.
  • Update Docusaurus/Webpack and ESLint configuration to support React Native Web + local linking of react-native-enriched-html sources.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
package.json Adds typecheck:docs and includes it in the top-level typecheck script.
eslint.config.mjs Adjusts ignore patterns intending to lint some docs sources.
docs/yarn.lock Updates docs dependency lockfile to include new dependencies (RN/RNW, raw-loader, etc.).
docs/tsconfig.json Adds a TS config for the docs workspace to typecheck example code and local library imports.
docs/src/theme/MDXComponents.js Registers InteractiveExample for use in MDX.
docs/src/examples/FirstEditor.tsx Adds the interactive “first editor” example component.
docs/src/components/InteractiveExample/styles.module.css Styles for the interactive preview/code switcher UI.
docs/src/components/InteractiveExample/index.tsx Implements the interactive preview/code switcher component.
docs/package.json Adds deps needed to render RN components in the docs site (RN/RNW) and raw-loader.
docs/docusaurus.config.js Adds Webpack/Docusaurus plugins for RNW aliasing and local-source linking/transpilation.
docs/docs/fundamentals/your-first-editor.mdx Replaces placeholder page with full tutorial + embedded interactive example.
docs/docs/fundamentals/your-first-editor.md Removes placeholder markdown file superseded by MDX.
docs/docs/fundamentals/html-format-and-supported-tags.md Adds supported tag reference content.
docs/docs/fundamentals/getting-started.md Adds getting started content with install instructions.
docs/docs/fundamentals/core-concepts.md Adds core concepts documentation (uncontrolled input, HTML model, normalization, state model).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/docusaurus.config.js
Comment thread eslint.config.mjs
Comment thread docs/src/components/InteractiveExample/index.tsx
@hejsztynx
hejsztynx changed the base branch from feat/docs to @ksienkiewicz/docs-fundamentals July 20, 2026 09:52

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

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Comment thread docs/tsconfig.json Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@hejsztynx
hejsztynx marked this pull request as ready for review July 20, 2026 11:39
Comment thread eslint.config.mjs

@kacperzolkiewski kacperzolkiewski left a comment

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.

LGTM

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.

3 participants