-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add dev documentation to react native aztec package/component #24276
Add dev documentation to react native aztec package/component #24276
Conversation
Size Change: -217 B (0%) Total Size: 1.16 MB
ℹ️ View Unchanged
|
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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!
Description
Adding a readme file for the react-native-aztec package.
How has this been tested?
Screenshots
Types of changes
Checklist: