rust
/
book
mirror of https://github.com/rust-lang/book
1
0
Fork 0
Code Issues Releases Wiki Activity
book/redirects/structs.md

26 lines
606 B
Markdown
Raw Permalink Normal View History

Put the chapter title as the title And reword the blurb to include what was previously in the title. This makes it easier to see that one has arrived to the right place: beforehand, the only indication was through the link target for the first edition; it was nowhere in the copy itself for most pages.
2017-12-30 12:00:14 +00:00
% Structs
add redirects for original book
2017-03-03 14:50:30 +00:00
Highlight recommended path and lowlight the rest Instead of placing the link to the recommended resource i.e. the second edition in second place, push it up to the top of the list. In fact, push the link to the first edition always at the bottom. To emphasise even more that's where new visitors should go, bolden the first link, and make the first-ed link smaller. All this as well as a slight edit and simplification of the copy is designed to make the new and recommended resources the primary path readers take, without hiding the old resource completely.
2017-12-31 03:21:47 +00:00
<small>There is a new edition of the book and this is an old link.</small>
Add blurb and code example To improve immediate value and reduce discard-because-not-useful factor upon arriving at a page which does not contain the content you were expecting, add a small blurb taken/adapted from the newer source, optionally accompanied by a code sample describing the feature. However, due to the transitive nature of this resource, there must be no content here that isn't available elsewhere.
2017-12-31 01:56:24 +00:00
> A _struct_ is a custom data type that lets us name and package together multiple related values that make up a meaningful group.
```rust
struct User {
username: String,
email: String,
sign_in_count: u64,
active: bool,
}
```
---
Highlight recommended path and lowlight the rest Instead of placing the link to the recommended resource i.e. the second edition in second place, push it up to the top of the list. In fact, push the link to the first edition always at the bottom. To emphasise even more that's where new visitors should go, bolden the first link, and make the first-ed link smaller. All this as well as a slight edit and simplification of the copy is designed to make the new and recommended resources the primary path readers take, without hiding the old resource completely.
2017-12-31 03:21:47 +00:00
Here are the relevant sections in the new and old books:
add redirects for original book
2017-03-03 14:50:30 +00:00
Highlight recommended path and lowlight the rest Instead of placing the link to the recommended resource i.e. the second edition in second place, push it up to the top of the list. In fact, push the link to the first edition always at the bottom. To emphasise even more that's where new visitors should go, bolden the first link, and make the first-ed link smaller. All this as well as a slight edit and simplification of the copy is designed to make the new and recommended resources the primary path readers take, without hiding the old resource completely.
2017-12-31 03:21:47 +00:00
* **[In second edition: Ch 5.00 — Structs][2]**
* <small>[In the first edition: Ch 3.12 — Structs][1]</small>
Make explanation on redirect pages shorter to make the links forward obvious
2017-06-14 18:11:46 +00:00
Update links in redirects
2018-12-07 14:56:43 +00:00
[1]: https://doc.rust-lang.org/1.30.0/book/first-edition/structs.html
[2]: ch05-00-structs.html