Skip to content

Suggestion: Link each mention of a React API to the reference docs #2630

Open
@opcodewriter

Description

@opcodewriter

I'm new to React and just started reading the documentation.

I noticed that references to the API are not links, just plain text. It would be helpful if they were actual links to the API.

Example: On this page https://reactjs.org/docs/rendering-elements.html it says:

image

The yellow API reference should actually be a link to the ReactDOM.render(), meaning a link to https://reactjs.org/docs/react-dom.html#render.
This helps me a lot because I can easily discover the complete reference of that function, the complete list and description of the parameters, function behaviors, different possible usage, etc.
As I go through the documentation and concepts, I can quickly go back and forth between concepts and API reference. It's much quicker to have links I can open in a new tab, instead of manually searching in the API reference every time.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions