atlassian-labs / react-resource-router

Configuration driven routing solution for React SPAs that manages route matching, data fetching and progressive rendering
https://atlassian-labs.github.io/react-resource-router
Apache License 2.0
202 stars 28 forks source link

correction for docs to go correct page instead of 404 #84

Closed mahmood-sajjadi closed 3 years ago

mahmood-sajjadi commented 3 years ago

Some of the links in docs are going to 404 due to missing folder/extension name in url or typos.

atlassian-cla-bot[bot] commented 3 years ago

Hooray! All contributors have signed the CLA.

mahmood-sajjadi commented 3 years ago

Ok I revert some of my changes as I found this link https://atlassian-labs.github.io/react-resource-router/#/ from Atlassian internal resources (I am an Atlassian developer) But this link is not available in npm or repo itself. I am suggesting to change the link in npm https://www.npmjs.com/package/react-resource-router for Homepage to docs links otherwise none of the docs link in github will work. If you open the docs in github itself, all of the links will go to 404 as /docs/ and extension (.md) is missing from the urls

albertogasparin commented 3 years ago

Thanks for the fix! Yeah, supporting both .md navigation and website navigation would be nice. By looking at how we did it in https://github.com/atlassian/react-sweet-state/tree/master/docs it might be a matter of converting all /bla/foo to be relative (bla/foo). Would you like to give it a go?

mahmood-sajjadi commented 3 years ago

sure that would be an honor. I will update this PR to be the relative link

mahmood-sajjadi commented 3 years ago

Done, all of them links in PR changed to be relative links.