Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upRWIB Mission 5: Documentation Page #179
Comments
brson
changed the title
RWIB Mission 4: Documentation Page
RWIB Mission 5: Documentation Page
Aug 28, 2015
edunham
added
the
RWIB Missions
label
Aug 28, 2015
This comment has been minimized.
This comment has been minimized.
ghost
commented
Oct 11, 2015
|
I would like to take this on after #193. |
This comment has been minimized.
This comment has been minimized.
|
@efindlay You got it! Thanks! |
This comment has been minimized.
This comment has been minimized.
ghost
commented
Oct 13, 2015
|
It looks like my first step should just be a pure refactor with no visible changes (except for URL). I'm guessing the tricky part will be finding and changing links to the current documentation landing page. I'd like to confirm that links to
|
This comment has been minimized.
This comment has been minimized.
ghost
commented
Oct 13, 2015
This comment has been minimized.
This comment has been minimized.
ghost
commented
Oct 13, 2015
|
Grepped with, git grep -En 'doc.rust-lang.org[^/]' |
This comment has been minimized.
This comment has been minimized.
ghost
commented
Oct 13, 2015
|
Oh. Only links were part of #![doc ... html_root_url = https://doc.rust-lang.org/nightly/ which doesn't need to change, does it? |
brson
referenced this issue
Dec 23, 2015
Closed
Add a documentation page. Restructure navigation #241
This comment has been minimized.
This comment has been minimized.
|
This is done. |
brson commentedAug 28, 2015
Link.
Today, the documentation landing
page lives in the Rust tree, and
is generated for each release channel. As Rust grows though, more
documentation lives out of tree and needs to be discoverable.
Let's reorganize this so that the website itself is the main landing
page for finding docs.
Start by moving the contents of the existing documentation index into
rust-www, reducing the existing doc index to links to the in-tree
docs, as well as a link to the website for more information.
Add a link to the new website-based FAQ.
Brainstorm about other documentation we might want to link to and what
standards of quality and stability we might require before officially
endorsing them.