reposting what I'd said in the other stream:
update on book things:
I've gotten link checker running on the book and am working to pull out the example code into separate projects in an examples/ workspace inside the async book repo, update those to the current library/syntax, and get tests running in CI. Once that's done, it should be easier to start accepting PRs for new content.
If anyone wants to start working on content, feel free to take a look at the table of contents: https://github.com/rust-lang/async-book/blob/master/src/SUMMARY.md, and open an issue mentioning that you plan to get started
There's a lot there left TODO, and I'll aim to have a PR up today with the examples and everything factored out so we can get started
I don't have any other updates to give, but if someone has a topic they'd like to discuss we could take some time to do that as a group
I don't have much right now; I mentioned in last week's Async Eco WG meeting that we'd be having this meeting today.
Is it now checking that the code examples build?
(hoping we can funnel folks from the eco WG in here to help out :smile:)
@nikomatsakis it is not, but that was what I was referring to when I talked about moving the examples into cargo projects within an examples/ workspace
@Taylor Cramer ok -- I think if you use mdbook, you can do
mdbook test to test the code examples, also?
if there's another way to do that you know which works well with dependencies on crates.io libraries, I'd be happy to hear
though I'm not sure
yeah, maybe it doesn't handle the deps very well
^^yes, but i think it requires manual
-L lines for deps
which isn't that bad, but I think would turn a bit more "bespoke"
let's first spend 6 months building a good tool
also there are some things that could be better in markdown
so let's fix that too
so yeah I was gonna not solve that problem
I think a good bit of homework for me would be to sit down and read the whole book "cover to cover" :)
regardless, it'd be nice to have it rendered at rust-lang.github.io/async-book etc
that'd probably yield better results once any of the code examples compiled or were up-to-date ;)
not sure if that's also what you meant in your paragraph above
tbh I found it kind of hard to parse :P
Yes, currently the .travis.yml file uploads it
oh hey it works already sorry i'll just shut up
The bit I was talking about was two things:
- adding link checker so we can be sure that internal links between the pages don't go stale (DONE)
- moving code examples into a cargo workspace and using the mdbook #include syntax to pull the relevant parts into the docs
https://rust-lang-nursery.github.io/mdBook/format/mdbook.html is the relevant section of the docs
then we can use
cargo test --all inside examples/ to ensure that all the code is still building and running correctly
@Taylor Cramer would you object if I fork the repo and experiment with a bit of TOC reordering?
I had an idea I wanted to try out
may or may not be an improvement...
@nikomatsakis nope, that's fine by me, but i'd been planning to do some rearranging myself
specifically I was thinking like this:
happy to have you take a look at it though, as a new set of eyes is always good
I'm also going to read it and see how much I understand :)