docs: miscellaneous section - #723
Open
hejsztynx wants to merge 11 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds initial content for the “Misc” documentation section of React Native Enriched HTML, replacing TODO placeholders with contributor guidance and platform/feature notes.
Changes:
- Add initial “Roadmap” and “Known limitations” pages with cross-links.
- Add a comprehensive “Contributing” page describing the dev workflow and test commands.
- Replace
compatibility.mdwith a newcompatibility.mdxpage outlining platform differences and compatibility notes.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/misc/roadmap.md | Adds a roadmap page describing planned feature areas. |
| docs/docs/misc/known-limitations.md | Documents current cross-platform limitations and links to related docs. |
| docs/docs/misc/contributing.md | Adds detailed contributor workflow, tooling, and testing guidance. |
| docs/docs/misc/compatibility.mdx | Introduces a compatibility/platform-differences page (MDX). |
| docs/docs/misc/compatibility.md | Removes the previous placeholder compatibility page. |
| docs/docs/misc/comparison-with-other-libraries.md | Leaves the comparison page as header-only (needs placeholder/content). |
Comments suppressed due to low confidence (1)
docs/docs/misc/comparison-with-other-libraries.md:6
- This page currently renders as an empty section (header only). Adding a short placeholder helps readers understand it’s intentionally unfinished until the comparison content is added.
# Comparison with other libraries
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kacperzolkiewski
marked this pull request as draft
July 23, 2026 11:32
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (3)
docs/src/components/Compatibility/EnrichedCompatibility.tsx:51
- The first cell in each body row is effectively a row header (the library version). Using
<th scope="row">instead of<td>improves table semantics/accessibility.
<td>
<Version version={version} />
</td>
docs/docs/misc/compatibility.mdx:75
## HTML is not sanitized (Mobile)is placed after## Platform differences, but as a level-2 heading it breaks out of that section, and the following### React Native layout ref methodsbecomes nested under it. Make this a level-3 heading so both items remain part of "Platform differences".
## HTML is not sanitized (Mobile)
On iOS and Android, the library does not sanitize HTML. It makes no guarantees that the markup it accepts or produces is safe. You are fully responsible for sanitizing any HTML you persist, render elsewhere, or accept from untrusted sources.
Sanitization _is_ enforced on the web, as injecting unsafe HTML directly into the DOM poses severe security risks (like XSS).
### React Native layout ref methods
docs/docs/misc/roadmap.md:23
- "ACA" is typically the Affordable Care Act and isn't an accessibility standard; for accessibility compliance in the US it's usually "ADA" (or Section 508). Consider replacing this to avoid confusing readers.
Support for screen readers and accessibility APIs,
delivering a rich, inclusive text editing experience while aligning with WCAG
and ACA standards.
kacperzolkiewski
marked this pull request as ready for review
July 23, 2026 15:40
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
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
Added the
Miscsection to the docs.