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

[Docs] Document how links to other pages should be formatted #240

Closed
hramos opened this issue Nov 21, 2017 · 8 comments
Closed

[Docs] Document how links to other pages should be formatted #240

hramos opened this issue Nov 21, 2017 · 8 comments
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.

Comments

@hramos
Copy link
Contributor

hramos commented Nov 21, 2017

Should clients update all their links?

React Native's links are in the following format:

[Tutorial](docs/tutorial.html)

This is resulting in broken links to docs/docs/tutorial.html. I fixed it by updating the link to

[Tutorial](Tutorial.md)

This is sort of documented in the basics example, in doc2.md, but it could be more obvious (maybe as part of Preparing your Site).

@JoelMarcey JoelMarcey added the good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. label Dec 7, 2017
@ppatel221
Copy link
Contributor

Hey I'm a student in an open source development class. Can i help with this bug?

@JoelMarcey
Copy link
Contributor

@ppatel221 Hi! Absolutely. Please send a pull request. We would be happy to review it.

@JoelMarcey
Copy link
Contributor

...and if afterwards (or in parallel) you want something code related and related to this issue, there is #257 as well.

@ppatel221
Copy link
Contributor

I can also take a look at that bug! Can you help me get started with this? What would be my first step

@JoelMarcey
Copy link
Contributor

@ppatel221 I wold start by reading the contributing documentation. That should help you get oriented on how to generally make pull requests for this project.

@ppatel221
Copy link
Contributor

I've requested PR for one of the links I updated. Are there more places that need these updates?
#366

@ppatel221
Copy link
Contributor

Ive requested a PR here as well reactjs/react.dev#478

@alexkrolick
Copy link
Contributor

@ppatel221 ReactJS doesn't use Docusaurus, I think you may have intended to update the React Native docs.

JoelMarcey added a commit to JoelMarcey/Docusaurus that referenced this issue Jan 12, 2018
JoelMarcey added a commit that referenced this issue Jan 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin.
Projects
None yet
Development

No branches or pull requests

4 participants