RN Docs Weekly Check In

Blockers

• Review on the autogenerate scripts (potential improvements, bugs, code quality, etc):

  • Prior work
  • Patch 1 of the script(MLH work)

• Review on Modal component PR.

• Review on component PRs open on react native.

• Meeting with the docs team to learn about the documentation standards.

• Publish latest version of react-docgen fork to npm.

• Review on PRs created on FB's React-Native repo ( Button component ).

Queries

(Also, next meeting's agenda)

• Discussion on function generateMethodSignatureBlock(method, component)

  

• ImageBackground and SafeAreaView component.

• Create the next patch for the script before merging of 2 PRs (like a patch 2)?

• Discuss about the week's goal and success of the project.

• After fellowship (maintaining the project, team meetings, etc) - Long term goals.

• We are using latest conventions of documentation introduced in the Button and ActivityIndicator component. For example, using the required label in the prop title instead of a column in prop table). This would differ in cases where documentation has not been updated. The documentation generated using script (for components that are not up-to-date) can be presented to the team to show how autogen script reduces the efforts. Would there be a meeting with RN team?

• Inconsistency in the documentation. For example, prop type boolean is displayed as boolean in some cases whearas bool in most cases. This prevents us from getting to a point of 0 diff in actual and generated docs.

• Newly introduced TypeDefination in RefreshControl. Various other sections that need to be discussed.

• Is it better to show function arg in type of prop Eg: Switch.