Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RWIB Mission 5: Documentation Page #179

Closed
brson opened this Issue Aug 28, 2015 · 7 comments

Comments

Projects
None yet
2 participants
@brson
Copy link
Contributor

brson commented Aug 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.

@brson brson changed the title RWIB Mission 4: Documentation Page RWIB Mission 5: Documentation Page Aug 28, 2015

@ghost

This comment has been minimized.

Copy link

ghost commented Oct 11, 2015

I would like to take this on after #193.

@brson

This comment has been minimized.

Copy link
Contributor Author

brson commented Oct 12, 2015

@efindlay You got it! Thanks!

@ghost

This comment has been minimized.

Copy link

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

  1. https://doc.rust-lang.org/std/
  2. https://doc.rust-lang.org/nightly/
  3. https://doc.rust-lang.org/
    should all point to one page.
@ghost

This comment has been minimized.

Copy link

ghost commented Oct 13, 2015

Grepped with,

git grep -En 'doc.rust-lang.org[^/]'
git grep -En 'doc.rust-lang.org/[^a-z]'
git grep -En 'doc.rust-lang.org/index.html'
git grep -En 'doc.rust-lang.org/nightly[^/]'
git grep -En 'doc.rust-lang.org/nightly/[^a-z]'
git grep -En 'doc.rust-lang.org/nightly/index.html'
git grep -En 'doc.rust-lang.org/stable[^/]'
git grep -En 'doc.rust-lang.org/stable/[^a-z]'
git grep -En 'doc.rust-lang.org/stable/index.html'

@ghost

This comment has been minimized.

Copy link

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

This comment has been minimized.

Copy link
Contributor Author

brson commented Jan 14, 2016

This is done.

@brson brson closed this Jan 14, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.