react-native-website icon indicating copy to clipboard operation
react-native-website copied to clipboard

iOS and Android tags are used, but not explained

Open C-Otto opened this issue 4 years ago • 12 comments

Description

The documentation makes liberal use of tags labelled 'iOS' and 'Android', without explaining the consequence of having a tag on some functionality.

What is the problem?

As a beginner I'd like to read the documentation and understand what to do, what to expect. Currently, I just realize that a feature is related to iOS or Android, but I don't know enough to gain any insights.

How can we address it?

Add a hover text or link that explains the meaning of the tag. Add a legend to the documentation that explains the meaning of tags (and other symbols) used.

Why is it important?

The tag seems to convey important information, but as a beginner I don't understand what kind of information that might be.

Who needs this?

New learners.

When should this happen (use version numbers if needed)?

Examples:

  • https://reactnative.dev/docs/activityindicator#hideswhenstopped-ios
  • https://reactnative.dev/docs/statusbar#currentheight-android

C-Otto avatar Mar 31 '22 12:03 C-Otto

I guess this is the documentation I'm supposed to find? Adding the tag symbols here might be a good first step.

https://reactnative.dev/docs/platform-specific-code

Certain components may have properties that work on one platform only. All of these props are annotated with @platform and have a small badge next to them on the website.

C-Otto avatar Mar 31 '22 14:03 C-Otto

Add a hover text or link that explains the meaning of the tag

This sounds like a good addition. Do you want to try to send a PR?

cortinico avatar Mar 31 '22 15:03 cortinico

No. I'm too stupid for CSS, sorry.

C-Otto avatar Mar 31 '22 15:03 C-Otto

👋 Hey there, it looks like there has been no activity on this issue in the last 90 days. Has the issue been fixed, or does it still require the community attention? This issue will be closed in the next 7 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Jun 30 '22 02:06 github-actions[bot]

It certainly didn't fix itself. Please disable this bot.

C-Otto avatar Jun 30 '22 05:06 C-Otto

👋 Hey there, it looks like there has been no activity on this issue in the last 90 days. Has the issue been fixed, or does it still require the community attention? This issue will be closed in the next 7 days if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 29 '22 02:09 github-actions[bot]

It certainly didn't fix itself. Please disable this bot.

C-Otto avatar Sep 30 '22 07:09 C-Otto

@github-actions bot will haunt you...

till you sacrifice dat PhD for some cool flexbox Udemy course (;

leotm avatar Nov 29 '22 21:11 leotm

I'd rather be haunted than do frontend stuff.

C-Otto avatar Nov 29 '22 21:11 C-Otto

It certainly didn't fix itself. Please disable this bot.

C-Otto avatar Feb 28 '23 07:02 C-Otto

It certainly didn't fix itself. Please disable this bot.

C-Otto avatar May 31 '23 10:05 C-Otto

I'm working on this issue

mwenku avatar Feb 17 '24 07:02 mwenku