How to document for different platforms

[oandregal]

We're increasing the code we share between mobile and web, so we need to figure out ways to automatically document what belongs to each platform.

Reference: (core-js slack conversation).

• In consolidating some components to work for on web and mobile (ReactDOM and React Native) we have the need to mark some props to belong only in a specific platform (example, className is another web-only prop).
• We also likely need to mark some to work on Android or iOS.
• There might be props that are required in one platform but not in another. Pending use case.
• Event handlers are a bit more nuanced. We're aiming to have the same API, but some cases may need to be declared per-platform (for ex: onError).

Some examples:

• ReactNative's RefreshControl (code, docs). It looks like they generate the docs from source.
• IonicFramework docs.
• Apple Developer Documentation.

[hypest]

FYI, added this to the "Mobile Apps" project board to cover the apps side of the issue.

[oandregal]

docgen has been in use for a few years now and this hasn't been an issue. We can reopen if it becomes one.