Skip to content

Link to official version of internal API documentation in contributing.md #2591

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
phansch opened this issue Mar 29, 2018 · 2 comments
Closed

Link to official version of internal API documentation in contributing.md #2591

phansch opened this issue Mar 29, 2018 · 2 comments
Labels
A-documentation Area: Adding or improving documentation good-first-issue These issues are a good way to get started with Clippy
Milestone
1.0

Comments

@phansch
Copy link
Member

phansch commented Mar 29, 2018 •
edited
Loading

The CONTRIBUTING.md currently links to http://manishearth.github.io/rust-internals-docs in two places.

Once rust-lang/rust-central-station#40 is merged, there will be a stable location for the internal API documentation and we should link to that instead.

The new API docs will be at https://doc.rust-lang.org/nightly-rustc
@phansch phansch added good-first-issue These issues are a good way to get started with Clippy A-documentation Area: Adding or improving documentation labels Mar 29, 2018
@phansch phansch changed the title Link to stable version of internal API documentation in contributing.md Link to official version of internal API documentation in contributing.md Mar 29, 2018
@oli-obk oli-obk added this to the 1.0 milestone Mar 30, 2018
@phansch
Copy link
Member Author

phansch commented Apr 4, 2018

The new docs are now live at https://doc.rust-lang.org/nightly/nightly-rustc/rustc/. With c170e86 there is only one link left that will have to be fixed 👍

@Manishearth
Copy link
Member

1c73db1

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
A-documentation Area: Adding or improving documentation good-first-issue These issues are a good way to get started with Clippy
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
3 participants
@oli-obk @Manishearth @phansch