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

Copy contents of README.md from librustc/hir #23

Merged
merged 1 commit into from
Jan 24, 2018

Conversation

theotherphil
Copy link
Contributor

Literally just copy-pasting (s/README/chapter/) @nikomatsakis's README from librustc.

Not sure if it's worth landing this as-is or if we should wait until I've added some more content.

@nikomatsakis
Copy link
Contributor

I say let's add it! I'd love to stand this book up as far as possible as a useful thing to look at.

mod foo {
fn bar() { }
}
```
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we can start testing these code samples. That might .. actually be a way for us to test links too? Gonna take a bit of work to make that easy I suppose.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@Michael-F-Bryan Michael-F-Bryan Jan 24, 2018

Choose a reason for hiding this comment

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

Now version 0.1.0 of mdbook is out, we might be able to use my mdbook-test backend. It's essentially gets a copy of the document from mdbook and then runs rust-skeptic over it.

I found it worked pretty well locally but the CI tests were quite flaky and would fail for unknown reasons. It also needs to be updated to pull mdbook from crates.io instead of the git repository.

@nikomatsakis nikomatsakis merged commit 580f301 into rust-lang:master Jan 24, 2018
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 this pull request may close these issues.

3 participants