Add a ton of links :)
killercup opened this issue · 3 comments
Very nice, I really like your style of writing! It's a bit more sudden in introducing new things, and mentions a lot of nice details on the side. I only wish you'd add some links to learn more about that :)
For example, here, when you introduce formatting syntax with println!("{:.1} ",x);, people might wonder where they can lear more about this, so why not add a link to the std::fmt docs? (This is also one of the most underappreciated parts of the std docs!)
Or, when you introduce Option, Vec, Iterator, etc. and present a few methods – their API docs have so many other interesting things!
You're quite right - just saying 'like Python' is a bit throwaway. Yeah, the more links the better - and there are some brilliant sections of the documentation like std::fmt. I suspect I 'underwrite' a bit, need to flesh out those interesting details.
Links between the pages would be nice, too.
That's one of those ideas which are obvious in hindsight. It's not really a book and I can refer back to earlier sections.
Another thing I'm thinking of, is providing links to the source. The src directory has a lot of little test programs, and I may be able to persuade mdbook to render them for me.
As I go through the text, I'm putting in as many doc links as possible. There's even a section on how to read the docs (start of section 5) because man the first time I saw them I was scared (and I don't scare easily)