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 the docs #612

Merged
merged 8 commits into from
Apr 1, 2019
Merged

fix the docs #612

merged 8 commits into from
Apr 1, 2019

Conversation

ashleygwilliams
Copy link
Member

No description provided.

@ashleygwilliams ashleygwilliams added the work in progress do not merge! label Apr 1, 2019
@ashleygwilliams ashleygwilliams added this to the 0.8.0 milestone Apr 1, 2019
@ashleygwilliams ashleygwilliams changed the title feat(ci): print mdbook version fix the docs Apr 1, 2019
Copy link
Member

@drager drager left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I serve this locally and navigate to: http://localhost:3000/ it works at first glance, however if I navigate to: http://localhost:3000/prerequisites/index.html via the left side menu and then click on the here link I get redirected to: http://localhost:3000/prerequisites/prerequisites/non-rustup-setups.html (the same behavior happens for the npm link) which is not what we want.

I also found a broken link in this file: https://raw.githubusercontent.com/rustwasm/wasm-pack/master/docs/src/prerequisites/npm.md the [Tutorial]: ../tutorial/index.html should be [Tutorial]: ../tutorials/index.html. Mind fixing that in this PR as well?

@drager
Copy link
Member

drager commented Apr 1, 2019

Found another broken link here in the bottom: https://raw.githubusercontent.com/rustwasm/wasm-pack/master/docs/src/tutorials/npm-browser-packages/getting-started/manual-setup.md Should also be tutorials.

Copy link
Member

@fitzgen fitzgen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@ashleygwilliams
Copy link
Member Author

ok so:

the weird "relative link "bug"" was actually because mdbook shows the prereq page as the "landing page" at "/" (root route of the docs) and when you click on it "prerequisites/index.html", this makes our usage of ".." in the paths problematic.

to fix this, i opted to solve a different problem. instead of landing folks on the prereqs page, we now land them on this. it has no relative links and so i have removed the problem.
Screen Shot 2019-04-01 at 3 49 13 PM

@ashleygwilliams
Copy link
Member Author

added some more stuff from the readme per @drager 's excellent suggestion.

Screen Shot 2019-04-01 at 3 51 19 PM

fitzgen and others added 2 commits April 1, 2019 16:07
…go-toml.md

Co-Authored-By: ashleygwilliams <ashley666ashley@gmail.com>
…-lib-rs.md

Co-Authored-By: ashleygwilliams <ashley666ashley@gmail.com>
@ashleygwilliams ashleygwilliams merged commit 1fc01c5 into master Apr 1, 2019
@ashleygwilliams
Copy link
Member Author

merging before CI because the relevant tests passed and i would like to get a release out.

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

Successfully merging this pull request may close these issues.

3 participants