Add dev documentation to react native aztec package/component

[SergioEstevao]

Description

Adding a readme file for the react-native-aztec package.

How has this been tested?

Screenshots

Types of changes

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows the accessibility standards.
• My code has proper inline documentation.
• I've included developer documentation if appropriate.
• I've updated all React Native files affected by any refactorings/renamings in this PR.

[github-actions]

Size Change: -217 B (0%)

Total Size: 1.16 MB

Filename	Size	Change
build/block-editor/index.js	125 kB	-54 B (0%)
build/block-library/editor-rtl.css	7.59 kB	+14 B (0%)
build/block-library/editor.css	7.59 kB	+14 B (0%)
build/block-library/index.js	132 kB	-203 B (0%)
build/blocks/index.js	48.3 kB	+28 B (0%)
build/core-data/index.js	11.8 kB	+4 B (0%)
build/editor/index.js	45.3 kB	-20 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
build/a11y/index.js	1.14 kB	0 B
build/annotations/index.js	3.67 kB	0 B
build/api-fetch/index.js	3.44 kB	0 B
build/autop/index.js	2.82 kB	0 B
build/blob/index.js	620 B	0 B
build/block-directory/index.js	7.93 kB	0 B
build/block-directory/style-rtl.css	953 B	0 B
build/block-directory/style.css	952 B	0 B
build/block-editor/style-rtl.css	10.8 kB	0 B
build/block-editor/style.css	10.8 kB	0 B
build/block-library/style-rtl.css	7.76 kB	0 B
build/block-library/style.css	7.77 kB	0 B
build/block-library/theme-rtl.css	728 B	0 B
build/block-library/theme.css	729 B	0 B
build/block-serialization-default-parser/index.js	1.88 kB	0 B
build/block-serialization-spec-parser/index.js	3.1 kB	0 B
build/components/index.js	200 kB	0 B
build/components/style-rtl.css	15.7 kB	0 B
build/components/style.css	15.7 kB	0 B
build/compose/index.js	9.68 kB	0 B
build/data-controls/index.js	1.29 kB	0 B
build/data/index.js	8.45 kB	0 B
build/date/index.js	5.38 kB	0 B
build/deprecated/index.js	772 B	0 B
build/dom-ready/index.js	568 B	0 B
build/dom/index.js	3.23 kB	0 B
build/edit-navigation/index.js	10.9 kB	0 B
build/edit-navigation/style-rtl.css	1.08 kB	0 B
build/edit-navigation/style.css	1.08 kB	0 B
build/edit-post/index.js	304 kB	0 B
build/edit-post/style-rtl.css	5.61 kB	0 B
build/edit-post/style.css	5.61 kB	0 B
build/edit-site/index.js	17 kB	0 B
build/edit-site/style-rtl.css	3.06 kB	0 B
build/edit-site/style.css	3.06 kB	0 B
build/edit-widgets/index.js	9.38 kB	0 B
build/edit-widgets/style-rtl.css	2.45 kB	0 B
build/edit-widgets/style.css	2.45 kB	0 B
build/editor/editor-styles-rtl.css	537 B	0 B
build/editor/editor-styles.css	539 B	0 B
build/editor/style-rtl.css	3.8 kB	0 B
build/editor/style.css	3.79 kB	0 B
build/element/index.js	4.65 kB	0 B
build/escape-html/index.js	733 B	0 B
build/format-library/index.js	7.72 kB	0 B
build/format-library/style-rtl.css	547 B	0 B
build/format-library/style.css	548 B	0 B
build/hooks/index.js	2.13 kB	0 B
build/html-entities/index.js	621 B	0 B
build/i18n/index.js	3.56 kB	0 B
build/is-shallow-equal/index.js	711 B	0 B
build/keyboard-shortcuts/index.js	2.52 kB	0 B
build/keycodes/index.js	1.94 kB	0 B
build/list-reusable-blocks/index.js	3.11 kB	0 B
build/list-reusable-blocks/style-rtl.css	476 B	0 B
build/list-reusable-blocks/style.css	476 B	0 B
build/media-utils/index.js	5.33 kB	0 B
build/notices/index.js	1.79 kB	0 B
build/nux/index.js	3.4 kB	0 B
build/nux/style-rtl.css	671 B	0 B
build/nux/style.css	668 B	0 B
build/plugins/index.js	2.56 kB	0 B
build/primitives/index.js	1.41 kB	0 B
build/priority-queue/index.js	789 B	0 B
build/redux-routine/index.js	2.85 kB	0 B
build/rich-text/index.js	13.9 kB	0 B
build/server-side-render/index.js	2.71 kB	0 B
build/shortcode/index.js	1.7 kB	0 B
build/token-list/index.js	1.27 kB	0 B
build/url/index.js	4.06 kB	0 B
build/viewport/index.js	1.85 kB	0 B
build/warning/index.js	1.14 kB	0 B
build/wordcount/index.js	1.17 kB	0 B

_{compressed-size-action}

[mchowning]

This looks good to me but since Sergio is on sabbatical, would you mind giving it a look @cameronvoell? I made some small updates (mostly adding a bit of info about Android), and I would like to get another set of eyes on my changes.

Specifically, regarding my changes, I went fairly high level because I'm worried that it will never stay up-to-date if we go too deeply into Android's implementation details relating to the native Aztec view, but I'm certainly open to other opinions on this. 🙂

Also, I briefly looked into the automatic documentation that can be generated from JSDoc comments, but I did not find a straightforward way to use it with a React Component like AztecView and it looks like the automatic documentation generation isn't used with other components in the project currently. I would love to get this documentation to be derived from comments that are closer to the relevant code though, so I plan to look into that more, but I didn't think it was worth blocking this PR in the meantime.

[cameronvoell]

Specifically, regarding my changes, I went fairly high level because I'm worried that it will never stay up-to-date if we go too deeply into Android's implementation details relating to the native Aztec view, but I'm certainly open to other opinions on this. 🙂

I agree with the idea for starting broad with aspects that are less likely to change, and think what you added for Android is a perfect starting point.

Also, I briefly looked into the automatic documentation that can be generated from JSDoc comments, but I did not find a straightforward way to use it with a React Component like AztecView and it looks like the automatic documentation generation isn't used with other components in the project currently. I would love to get this documentation to be derived from comments that are closer to the relevant code though, so I plan to look into that more, but I didn't think it was worth blocking this PR in the meantime.

+1 for automated documentation. Also agree this PR is a worthy starting point that can be improved later.

The rest of the documentation that Sergio did all looks good to me!