updated links from azerupi to rust-lang-nursery #489
Conversation
There was a problem hiding this comment.
The PR is almost perfect @anna-liao!
Just some suggestions below
CONTRIBUTING.md
Outdated
| Use the [issue tracker](https://github.com/azerupi/mdBook/issues), no question is too simple. | ||
| If we don't respond in a couple of days, ping us @azerupi, @steveklabnik, @frewsxcv it might just be that we forgot. :wink: | ||
| Use the [issue tracker](https://github.com/rust-lang-nursery/mdBook/issues), no question is too simple. | ||
| If we don't respond in a couple of days, ping us @rust-lang-nursery, @steveklabnik, @frewsxcv it might just be that we forgot. :wink: |
There was a problem hiding this comment.
Im not sure that pinging rust-lang-nursery will work as expected but you can add me and Michael-F-Bryan
There was a problem hiding this comment.
Feel free to chuck me at the start of the list so people will ping me first, I think I've got a bit more spare time than the other guys.
README.md
Outdated
| @@ -113,13 +113,13 @@ Here are the main commands you will want to run. For a more exhaustive explanati | |||
|
|
|||
| Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with an easy to use API and more! | |||
|
|
|||
| See the [Documentation](http://azerupi.github.io/mdBook/lib/lib.html) and the [API docs](http://azerupi.github.io/mdBook/mdbook/index.html) for more information. | |||
| See the [Documentation](http://rust-lang-nursery.github.io/mdBook/lib/lib.html) and the [API docs](https://docs.rs/mdbook/0.0.26/mdbook/) for more information. | |||
There was a problem hiding this comment.
the api docs are still available under http://rust-lang-nursery.github.io/mdBook/mdbook/index.html
if you really like to point to docs.rs then I'd suggest pointing to wildcard version
https://docs.rs/mdbook/*/mdbook
which will always point to the newest version
There was a problem hiding this comment.
I'd prefer to point at docs.rs here, that way it's showing the docs for the latest release and not whatever happens to be in master. Later on if necessary, we can always add something to the README which gives links to both.
Documentation:
- [master](http://rust-lang-nursery.github.io/mdBook/lib/lib.html)
- [Latest Release](https://docs.rs/mdbook/*/mdbook/)Also, what about instead of using the word "Documentation" for the first link we say "User Guide"? That helps to differentiate between the API docs (used by people hacking on mdbook) and the user guide.
There was a problem hiding this comment.
Thanks @budziq and @Michael-F-Bryan for the review. So just checking:
[User Guide](http://rust-lang-nursery.github.io/mdBook/)
[API docs](https://docs.rs/mdbook/*/mdbook/)
Is that right?
book-example/src/README.md
Outdated
|
|
||
| ## API docs | ||
|
|
||
| Alongside this book you can also read the [API docs](mdbook/index.html) generated by Rustdoc if you would like | ||
| Alongside this book you can also read the [API docs](https://docs.rs/mdbook/0.0.26/mdbook/) generated by Rustdoc if you would like |
There was a problem hiding this comment.
please see my comment above about the api docs link
|
@budziq Thanks for the review :). I have revised as suggested. |
|
Thanks @anna-liao, I was going to work on this over the weekend but it looks like you beat me to it! 😁 It looks like while you were updating links |
There was a problem hiding this comment.
The changes regarding links look very well but
there are still quite a lot of rustfmt changes.
Could you go over the changes again?
- Squash the commits into one
- remove all files that did not require link change (or stage only the lines related to link change)
- git push to your PR branch with --force
If you'll have any problems we'll help out!
|
okie doke, reverted all |
|
Aww, I tried the "Resolve Conflicts" button from GitHub but it doesn't seem to have fixed the merge conflict 😞 This is good to merge @anna-liao! We just need to fix that last merge conflict (presumably someone also edited the README in a PR which was recently merged). EDIT: looks like it was c51e080. |
|
Merged. Thanks @anna-liao ! Nicely done! |
fixes #485 . The only link I didn't change was for appveyor.
I also clicked through the links on the updated documents to make sure there are no dead links.