Skip to content

Request for improvement: linking docs note about header search paths could be better explained #4750

@dannyhw

Description

@dannyhw

Description

What is the problem?

There is a note about adding something to header search paths that links to a page almost unrelated and doesn't tell you what the actual file path is supposed to be

Image
  1. a user can't be expected to know what the LinkingIOS folder is unless its mentioned in the docs somewhere
  2. the linked document shows a screenshot and nothing the user could copy paste
  3. The user is expected to find the file path themselves but we should not have any expectation that the user knows where to look even

Heres the page that it links to:

Image

This image renders quite small and its hard to even see the filepath and its not really even the same thing since its talking about linking libraries. This made me feel like I had ended up on the wrong page. I had to read everything like 3 times until I could understand what I was looking at.

Improving this slightly could make it much easier to setup linking since it would be easier to understand the actual steps neeed.

How can we address it?

  1. Remove the link to the separate page thats kinda unrelated
  2. provide a relevant screenshot that shows actually putting the LinkingIOS header search path in
  3. provide a file path to copy paste

something like this but scaled up maybe:

Image

Why is it important?

Setting up deeplinks is already kinda complicated and it should be made clearer to reduce friction from react-native's side of things.

Who needs this?

Especially people new to app development would need clearer documentation to not get stuck on this.

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

whenever possible

Metadata

Metadata

Assignees

No one assigned

    Labels

    StaleIssues/PR that are not getting much activity and are closer to be closed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions