9 ms·

Design choices shouldn't be a reason to not include the FAQ

by kekebo 7y ago

xondono 7y ago
It is if you are standardizing documentation. I don’t expect FAQs in the main website. https://doc.rust-lang.org/1.0.0/complement-lang-faq.html https://doc.rust-lang.org/1.0.0/complement-lang-faq.html
- kekebo 7y ago
  Given that a lot of these questions seem relevant for people considering to try rust for the first time, including some sort of link on the main website might be helpful.
- roblabla 7y ago
  A redirect would be helpful so the old links still work.
  - steveklabnik 7y ago
    We generally tried to have redirects, but we are humans and therefore fallible. Please file bugs!
    - roblabla 7y ago
      I would, but then the linked FAQ is outdated (in fact, the 1.20 version[0] indicates it moved to the website), and I don't think having a redirect that points to the prev website would work. According to [1], the presence of an FAQ on the website is an unresolved question. [0]: https://doc.rust-lang.org/1.20.0/complement-lang-faq.html https://doc.rust-lang.org/1.20.0/complement-lang-faq.html [1]: https://github.com/rust-lang/www.rust-lang.org/issues/445 https://github.com/rust-lang/www.rust-lang.org/issues/445
      - steveklabnik 7y ago
        Ah, I thought you could redirect to prev. Sorry about that!
- bscphil 7y ago
  Heh. "Currently, Rust is still pre-1.0" doesn't seem to agree with the URL. ;-)
  - steveklabnik 7y ago
    Just another demonstration of how easy it is to let this kind of thing get out of date.
steveklabnik 7y ago
Design had nothing to do with not including the FAQ. The FAQ was often out of date, hard to maintain. It was super long. It's not clear how often it was actually used.
- dmix 7y ago
  Was there a reason why the runnable code example (plus a link to more examples "Rust by Example") that was front & center of the old homepage was removed? I found it difficult to find any code examples on the new site.
  - steveklabnik 7y ago
    There's been a years-long discussion about how to get a good code sample, and we've never found anything satisfactory. Short examples don't show anything interesting, and interesting examples are too long. Nobody was happy with the old code sample, and nobody was happy with all of the suggested alternatives.
    - dmix 7y ago
      golangs multiple options (via dropdown) always seemed the best to me https://golang.org/ https://golang.org/ Nim's line length one is okay https://nim-lang.org/ https://nim-lang.org/ Although I'm sure you guys debated it to death already I still find it unusual to not be able to find a any example of actual within a few clicks. Committee-driven design is always difficult.
      - intertextuality 7y ago
        Go's page is for programmers; Rust's new page is for non-programmers. I think it's a mistake that you have to click "Get Started", then read through installation instructions, to finally see what Rust code looks like. It's all backwards. A short snippet (or two) should be front and center. Crystal lang is another very good example: https://crystal-lang.org/ https://crystal-lang.org/.
    - 7y ago

Design choices shouldn't be a reason to not include the FAQ

by kekebo 7y ago

Design choices shouldn't be a reason to not include the FAQ

It is if you are standardizing documentation. I don’t expect FAQs in the main website. https://doc.rust-lang.org/1.0.0/complement-lang-faq.html https://doc.rust-lang.org/1.0.0/complement-lang-faq.html

kekebo 7y ago
Given that a lot of these questions seem relevant for people considering to try rust for the first time, including some sort of link on the main website might be helpful.
roblabla 7y ago
A redirect would be helpful so the old links still work.
- steveklabnik 7y ago
  We generally tried to have redirects, but we are humans and therefore fallible. Please file bugs!
  - roblabla 7y ago
    I would, but then the linked FAQ is outdated (in fact, the 1.20 version[0] indicates it moved to the website), and I don't think having a redirect that points to the prev website would work. According to [1], the presence of an FAQ on the website is an unresolved question. [0]: https://doc.rust-lang.org/1.20.0/complement-lang-faq.html https://doc.rust-lang.org/1.20.0/complement-lang-faq.html [1]: https://github.com/rust-lang/www.rust-lang.org/issues/445 https://github.com/rust-lang/www.rust-lang.org/issues/445
    - steveklabnik 7y ago
      Ah, I thought you could redirect to prev. Sorry about that!
bscphil 7y ago
Heh. "Currently, Rust is still pre-1.0" doesn't seem to agree with the URL. ;-)
- steveklabnik 7y ago
  Just another demonstration of how easy it is to let this kind of thing get out of date.

steveklabnik 7y ago

Design had nothing to do with not including the FAQ. The FAQ was often out of date, hard to maintain. It was super long. It's not clear how often it was actually used.

dmix 7y ago
Was there a reason why the runnable code example (plus a link to more examples "Rust by Example") that was front & center of the old homepage was removed? I found it difficult to find any code examples on the new site.
- steveklabnik 7y ago
  There's been a years-long discussion about how to get a good code sample, and we've never found anything satisfactory. Short examples don't show anything interesting, and interesting examples are too long. Nobody was happy with the old code sample, and nobody was happy with all of the suggested alternatives.
  - dmix 7y ago
    golangs multiple options (via dropdown) always seemed the best to me https://golang.org/ https://golang.org/ Nim's line length one is okay https://nim-lang.org/ https://nim-lang.org/ Although I'm sure you guys debated it to death already I still find it unusual to not be able to find a any example of actual within a few clicks. Committee-driven design is always difficult.
    - intertextuality 7y ago
      Go's page is for programmers; Rust's new page is for non-programmers. I think it's a mistake that you have to click "Get Started", then read through installation instructions, to finally see what Rust code looks like. It's all backwards. A short snippet (or two) should be front and center. Crystal lang is another very good example: https://crystal-lang.org/ https://crystal-lang.org/.
  - 7y ago