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

Links don't work on github #109

Closed
mark-i-m opened this issue Apr 4, 2018 · 2 comments · Fixed by #184
Closed

Links don't work on github #109

mark-i-m opened this issue Apr 4, 2018 · 2 comments · Fixed by #184

Comments

@mark-i-m
Copy link
Member

mark-i-m commented Apr 4, 2018

as pointed out in #100 (comment)

We could make all of the links in the book absolute (always point to the guide) or we could leave them relative and just tell people to use the hosted mdbook version, rather than github... My personal leaning is towards the latter because it seems cleaner (easier to move the book later, easier to write, etc.)...

@nikomatsakis @Michael-F-Bryan Any thoughts?

cc @rajcspsg

@mark-i-m mark-i-m mentioned this issue Apr 4, 2018
4 tasks
@steveklabnik
Copy link
Member

This is always tricky with things like this. Once the guide makes its way into the "real" documentation, we'd want to leave them relative, so that things work offline.

This does make them not work on github, but that's effectively an impossible problem.

@mark-i-m
Copy link
Member Author

mark-i-m commented May 8, 2018

I think we can live with this. It seems more important to make contributing to the book easier, so I will close this. But if anyone has further comments, please do share :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants