Skip to content

docs: miscellaneous section - #723

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

docs: miscellaneous section#723
hejsztynx wants to merge 11 commits into
feat/docsfrom
@ksienkiewicz/docs-misc

Conversation

@hejsztynx

@hejsztynx hejsztynx commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

Added the Misc section to the docs.

@hejsztynx
hejsztynx requested a review from Copilot July 23, 2026 10:56
@hejsztynx hejsztynx changed the title @ksienkiewicz/docs misc docs: miscellaneous section Jul 23, 2026

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 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.md with a new compatibility.mdx page 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.

Comment thread docs/docs/misc/roadmap.md Outdated
Comment thread docs/docs/misc/contributing.md Outdated
Comment thread docs/docs/misc/compatibility.mdx Outdated
@kacperzolkiewski
kacperzolkiewski marked this pull request as draft July 23, 2026 11:32

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 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 methods becomes 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.

Comment thread docs/src/components/Compatibility/EnrichedCompatibility.tsx
Comment thread docs/src/components/Compatibility/EnrichedCompatibility.tsx Outdated
@kacperzolkiewski
kacperzolkiewski marked this pull request as ready for review July 23, 2026 15:40
Comment thread docs/docs/misc/compatibility.mdx Outdated
Comment thread docs/docs/misc/contributing.md
Comment thread docs/docs/misc/contributing.md Outdated
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