Suggestion: Link each mention of a React API to the reference docs #2630
Comments
|
Good suggestion! I know we do this in some places but we're not consistent about it. Any interest in submitting one or more PRs to add links in places where it would be relevant? |
sophiebits
changed the title
luisFilipePT
added a commit
to luisFilipePT/reactjs.org
that referenced
this issue
Mar 3, 2020
Link each mention of a React API in rendering-elements.md to the reference docs. On this page replace every static occurrence of `ReactDOM.render()` by link to the reference docs [`ReactDOM.render()`](/docs/react-dom.html#render) Is this in the right direction @sophiebits ? 🤔 ref reactjs#2630
sophiebits
pushed a commit
that referenced
this issue
Mar 4, 2020
Link each mention of a React API in rendering-elements.md to the reference docs. On this page replace every static occurrence of `ReactDOM.render()` by link to the reference docs [`ReactDOM.render()`](/docs/react-dom.html#render) Is this in the right direction @sophiebits ? 🤔 ref #2630
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
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.
The text was updated successfully, but these errors were encountered: