docs: project configuration#712
Open
hejsztynx wants to merge 8 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
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
typecheckscript. - Update Docusaurus/Webpack and ESLint configuration to support React Native Web + local linking of
react-native-enriched-htmlsources.
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.
hejsztynx
changed the base branch from
feat/docs
to
@ksienkiewicz/docs-fundamentals
July 20, 2026 09:52
hejsztynx
marked this pull request as ready for review
July 20, 2026 11:39
…t-docs-project-configuration
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
react-native-enriched-htmlis now linked locally.node_moduleshas become available now in the CI scripts.