Should links to API docs be absolute or relative?

[carols10cents]

The advantage of relative would be that if you're reading the book offline from your local install, the links to the docs will be to your local install as well. Print will need absolute, if we're putting in the URLs, since we haven't yet figured out how to make links relative to physical media.

Both are currently in use:

• Absolute
• Relative

(i'm not linking to the "blame" view in order to blame anyone, there's just not a great way to link to lines of the unrendered markdown at all :-/)

EDIT:

the links to the docs will be to your local install as well

wait, is this true still? Will this repo eventually be folded into rust-lang/rust and shipped? It's not true at the moment.

[steveklabnik]

They should be relative so offline docs work.

On Jul 9, 2016, 16:49 -0400, Carol (Nichols || Goulding)notifications@github.com, wrote:

The advantage of relative would be that if you're reading the book offline from your local install, the links to the docs will be to your local install as well. Print will need absolute, if we're putting in the URLs, since we haven't yet figured out how to make links relative to physical media.

Both are currently in use:

Absolute(https://github.com/rust-lang/book/blame/9f3d17f8d5448306cf57a4f2a2ec93d0fd1a4b36/src/ch06-01-enums.md#L118)
Relative(https://github.com/rust-lang/book/blame/9f3d17f8d5448306cf57a4f2a2ec93d0fd1a4b36/src/ch06-02-option.md#L48)

(i'm not linking to the "blame" view in order to blame anyone, there's just not a great way to link to lines of the unrendered markdown at all :-/)

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly,view it on GitHub(#131), ormute the thread(https://github.com/notifications/unsubscribe/AABsigfoDvUytMGQZogi_1VMHy61_J_Qks5qUAlpgaJpZM4JIsxy).

[carols10cents]

So this repo is getting merged into rust-lang/rust eventually
On Jul 10, 2016 11:18 AM, "Steve Klabnik" notifications@github.com wrote:

They should be relative so offline docs work.

On Jul 9, 2016, 16:49 -0400, Carol (Nichols || Goulding)<
notifications@github.com>, wrote:

The advantage of relative would be that if you're reading the book
offline from your local install, the links to the docs will be to your
local install as well. Print will need absolute, if we're putting in the
URLs, since we haven't yet figured out how to make links relative to
physical media.

Both are currently in use:

Absolute(
https://github.com/rust-lang/book/blame/9f3d17f8d5448306cf57a4f2a2ec93d0fd1a4b36/src/ch06-01-enums.md#L118
)
Relative(
https://github.com/rust-lang/book/blame/9f3d17f8d5448306cf57a4f2a2ec93d0fd1a4b36/src/ch06-02-option.md#L48
)

(i'm not linking to the "blame" view in order to blame anyone, there's
just not a great way to link to lines of the unrendered markdown at all :-/)

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly,view it on GitHub(
#131), ormute the thread(
https://github.com/notifications/unsubscribe/AABsigfoDvUytMGQZogi_1VMHy61_J_Qks5qUAlpgaJpZM4JIsxy
).

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#131 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AAL1Ulm4wXe2u0vHhA3YpxkObUtTecVmks5qUQ0xgaJpZM4JIsxy
.

[steveklabnik]

It's not clear if that's happening or not; but either way, it will still be distributed with Rust, and in general, it's always better to make stuff work offline if possible.