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.

Sign up for GitHub

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

Jump to bottom

No link from doc.rust-lang.org to www.rust-lang.org #30838

Closed
nodakai opened this issue Jan 12, 2016 · 9 comments · Fixed by #78726
Closed

No link from doc.rust-lang.org to www.rust-lang.org #30838

nodakai opened this issue Jan 12, 2016 · 9 comments · Fixed by #78726
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue.

Comments

@nodakai
Copy link
Contributor

nodakai commented Jan 12, 2016

We have no link from doc.rust-lang.org to www.rust-lang.org, and it is not good in terms of usability. I guess this is because doc.rust-lang.org is a verbatim copy of the raw output from rustdoc.

See how Python documents are organized:

python-doc-hdr

I think this is the relevant functionality of the Sphinx documentation tool for Python:

We should aim for the same level of usability standard and rustdoc should be flexible enough to achieve it.
@GuillaumeGomez
Copy link
Member

Generally, people come to doc.rust-lang.org from www.rust-lang.org. But that might be a good thing to add it.

@steveklabnik
Copy link
Member

Also, I don't think this can be a rustdoc thing, because many, many rustdoc outputs are not hosted on rust-lang.org

@steveklabnik
Copy link
Member

(Rustdoc already lets you choose where the logo links to, iiirc, but it's usually the docs rather than another site.)

@nodakai
Copy link
Contributor Author

nodakai commented Jan 26, 2016

@steveklabnik I'm not saying rustdoc should hard-code a link to www.rust-lang.org. If you write a Rust library and publicize its documentation, you might want a backlink from the generated HTML to www.steveklabnik.com. I'm claiming there should be a general mechanism to realize such designs.

Thankfully rustdoc supports these command line options which seem promising:

    --html-in-header FILES
                        files to include inline in the <head> section of a
                        rendered Markdown file or generated documentation
    --html-before-content FILES
                        files to include inline between <body> and the content
                        of a rendered Markdown file or generated documentation
    --html-after-content FILES
                        files to include inline between the content and
                        </body> of a rendered Markdown file or generated
                        documentation

I'll try see how they fit my proposal.

@steveklabnik steveklabnik added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed A-docs labels Jan 26, 2016
@steveklabnik
Copy link
Member

https://www.rust-lang.org/en-US/documentation.html now links to doc.rust-lang.org, many times 🎊

@steveklabnik steveklabnik reopened this Dec 22, 2016
@steveklabnik
Copy link
Member

Oh wait, this is the inverse issue, sorry for the noise! There hasn't been any change here.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 24, 2017
@steveklabnik
Copy link
Member

Triage: #44687 may fix this, but there's been no change

@Mark-Simulacrum
Copy link
Member

doc.rust-lang.org redirects to https://www.rust-lang.org/learn today, but I think we probably want these links from e.g. https://doc.rust-lang.org/std/index.html as well so leaving open.

@jyn514
Copy link
Member

jyn514 commented Nov 4, 2020

Triage: this would be pretty easily fixed by modifying the index page for doc.rust-lang.org: https://github.com/rust-lang/rust/blob/master/src/doc/index.md

@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Nov 4, 2020
@GuillaumeGomez GuillaumeGomez mentioned this issue Nov 4, 2020
Merged
@bors bors closed this as completed in 707988a Nov 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add link to rust website GuillaumeGomez/rust
5 participants
@steveklabnik @nodakai @GuillaumeGomez @Mark-Simulacrum @jyn514