Skip to content

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

New issue
New issue
Closed
#78726
Closed
No link from doc.rust-lang.org to www.rust-lang.org#30838
#78726
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-feature-requestCategory: A feature request, i.e: not implemented / a PR.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.
@nodakai

Description

@nodakai
nodakai
opened on Jan 12, 2016
Contributor

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.

Activity

GuillaumeGomez

GuillaumeGomez commented on Jan 12, 2016

@GuillaumeGomez
GuillaumeGomez
on Jan 12, 2016
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
added
A-docs
on Jan 26, 2016
steveklabnik

steveklabnik commented on Jan 26, 2016

@steveklabnik
steveklabnik
on Jan 26, 2016
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

steveklabnik commented on Jan 26, 2016

@steveklabnik
steveklabnik
on Jan 26, 2016
Member

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

nodakai

nodakai commented on Jan 26, 2016

@nodakai
nodakai
on Jan 26, 2016
ContributorAuthor

@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
added
T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
and removed
A-docs
on Jan 26, 2016
steveklabnik

steveklabnik commented on Dec 22, 2016

@steveklabnik
steveklabnik
on Dec 22, 2016
Member

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

steveklabnik
closed this as completedon Dec 22, 2016
steveklabnik
reopened this on Dec 22, 2016
steveklabnik

steveklabnik commented on Dec 22, 2016

@steveklabnik
steveklabnik
on Dec 22, 2016
Member

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

steveklabnik
added
T-tools
on Mar 9, 2017
steveklabnik
added
T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.
and removed
T-tools
on May 18, 2017
Mark-Simulacrum
added
C-feature-requestCategory: A feature request, i.e: not implemented / a PR.
on Jul 24, 2017

10 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-feature-requestCategory: A feature request, i.e: not implemented / a PR.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @steveklabnik@nodakai@GuillaumeGomez@Mark-Simulacrum@jyn514

      Issue actions
        No link from doc.rust-lang.org to www.rust-lang.org · Issue #30838 · rust-lang/rust