Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link on docs #1307

Merged
merged 1 commit into from Jun 11, 2019

Conversation

3 participants
@halitogunc
Copy link
Contributor

commented Jun 11, 2019

Some of the links take you to the wrong url which does not exist. This PR fixes it hopefully.

Halit Ogunc
@netlify

This comment has been minimized.

Copy link

commented Jun 11, 2019

Deploy preview for react-redux-docs ready!

Built with commit 96b817f

https://deploy-preview-1307--react-redux-docs.netlify.com

@timdorr

This comment has been minimized.

Copy link
Member

commented Jun 11, 2019

Thanks!

@timdorr timdorr merged commit 6e1e935 into reduxjs:master Jun 11, 2019

5 of 7 checks passed

Header rules - react-redux-docs No header rules processed
Details
Pages changed - react-redux-docs 4 new files uploaded
Details
Mixed content - react-redux-docs No mixed content detected
Details
Redirect rules - react-redux-docs 5 redirect rules processed
Details
codecov/project 98.31% remains the same compared to 0ce5f92
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
netlify/react-redux-docs/deploy-preview Deploy preview ready!
Details
@markerikson

This comment has been minimized.

Copy link
Contributor

commented Jun 11, 2019

This seems wrong and hacky to me.

The docs links are supposed to be based on the Markdown file paths, not the final web URL links.

I did note that we had some issues with relative file links when I was fixing up the hooks docs page for final release last night. @endiliey pointed out that Docusaurus really doesn't like relative links - they should be absolute instead.

Can we get another PR that changes all these links to be absolute instead? Like using-react-redux/connect-extracting-data-with-mapStateToProps.md, I think.

@halitogunc

This comment has been minimized.

Copy link
Contributor Author

commented Jun 11, 2019

I did not know that Docusaurus has some issues with relative link, but it makes sense to use absolute links instead of relative ones.

I will prepare another PR that applies these changes. @markerikson

@halitogunc

This comment has been minimized.

Copy link
Contributor Author

commented Jun 13, 2019

I am a bit confused about that topic. I don't have much experience on Docusaurus but its structure looks so dependent to relative links. Also there is an open issue regarding docs #1001. I might be missing something, need guidance 😄 . On the other hand we can keep the docs as it is and fix it on referenced issue above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.