Port the reference to mdbook by steveklabnik · Pull Request #39855 · rust-lang/rust

steveklabnik · 2017-02-15T19:59:01Z

Part of #39588.

This is only a work in progress. Still left to do:

double check contents weren't duplicated/lost with the move to individual pages (I'm going to do this)
fix up links and footnotes (@frewsxcv has volunteered to help with this)
change src/doc/reference.md to redirect to the book
move the reference on the doc index to be part of the bookshelf

rust-highfive · 2017-02-15T19:59:06Z

@steveklabnik: no appropriate reviewer found, use r? to override

petrochenkov · 2017-02-15T20:14:09Z

Will it still be available as a single Ctrl+F-able page?

steveklabnik · 2017-02-15T20:21:45Z

@petrochenkov IIRC the "print" view gives you that.

And, if for some reason it doesn't, fixing it in mdbook is quite possible. There's already a ticket open for actual search, for example.

petrochenkov · 2017-02-15T20:31:19Z

the "print" view gives you that.

Ha, indeed. I never noticed this little icon.
Can it get a huge label "click here for a single page view"?

The reference is mostly useless in multi-page format since it's primarily used for looking up stuff by keyword. I'd really like to see it single-page by default.

There's already a ticket open for actual search, for example.

If this search is going to remind the Discource search in any way, then that ticked would better stay open.
I think, I have a better ticket to solve - actual single-page representation.

steveklabnik · 2017-02-15T22:56:32Z

One wrinkle I noticed while doing this; mdbook doesn't support rustdoc's footnote syntax, which is really only used in the reference, if I recall. We'll have to handle those too.

steveklabnik · 2017-02-16T01:34:23Z

@frewsxcv given https://github.com/azerupi/mdBook/issues/204 you might not want to mess with the links yet; if they change the way they're generated, you'd have to do a second pass...

bors · 2017-02-16T05:53:17Z

☔ The latest upstream changes (presumably #39761) made this pull request unmergeable. Please resolve the merge conflicts.

steveklabnik · 2017-02-16T05:58:28Z

Hm, mdbook should support footnotes, given that pulldown-cmark does: https://github.com/google/pulldown-cmark/blob/master/tests/footnotes.rs

steveklabnik · 2017-02-16T06:44:11Z

I've sent in https://github.com/azerupi/mdBook/pull/207; let's see.

steveklabnik · 2017-02-16T19:34:43Z

I've built this off of my PR now; we'll see what's up.

@frewsxcv if you want to work on the links, fixing these ones should be fine; they'll be much more similar and less of them will be broken.

@alexcrichton I don't know how okay we are with working with forks of projects; I know @azerupi is busy at the moment, and it's been less than a day, so I don't want to rush him; I also don't know how long we want to block on upstream issues.

steveklabnik · 2017-02-17T00:36:34Z

Update, /cc @alexcrichton it looks like this is landing upstream soon, so I'll fix this up after it lands and we don't need to use my fork 😄

alexcrichton · 2017-02-17T05:45:12Z

👍

alexcrichton · 2017-02-17T05:45:34Z

Oh but yeah for now let's avoid github forks, let's stick to crates.io where we can

steveklabnik · 2017-02-19T01:20:24Z

Status: upstream is merged but needs a crates.io release.

steveklabnik · 2017-02-19T23:57:34Z

Updated mdbook PR made separately: #39966

bors · 2017-02-20T05:52:36Z

☔ The latest upstream changes (presumably #39966) made this pull request unmergeable. Please resolve the merge conflicts.

steveklabnik · 2017-02-20T14:44:13Z

Blocked on #39976

bors · 2017-02-20T21:32:27Z

☔ The latest upstream changes (presumably #39981) made this pull request unmergeable. Please resolve the merge conflicts.

steveklabnik · 2017-02-20T22:29:29Z

This is now ready to go; all we need are fixing up the links. @frewsxcv is on it! ❤️

steveklabnik · 2017-02-21T03:07:26Z

I've pushed a commit to deal with the footnotes, and opened https://github.com/azerupi/mdBook/issues/210 so we can address it upstream as well.

steveklabnik · 2017-02-21T06:09:20Z

At this point, all of the links in the reference itself are updated. Still gotta do the standard library and the book...

This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

I double checked that everything is here and in the correct order; this fixes things up

This affects the book, some missed things in the reference, the grammar, and the standard library. Whew!

Until https://github.com/azerupi/mdBook/issues/210 is resolved, we'll import the css file.

steveklabnik · 2017-02-21T19:06:38Z

This should now be good to go! 😄

/cc @rust-lang/docs

steveklabnik · 2017-02-21T19:07:12Z

Given that both @frewsxcv and I worked on this, I guess

r? @GuillaumeGomez ❤️

GuillaumeGomez · 2017-02-21T22:00:54Z

Seems all good to me (that was quite the review...). Thanks to both of you!

@bors: r+

bors · 2017-02-21T22:00:56Z

📌 Commit 55c02f6 has been approved by GuillaumeGomez

bors · 2017-02-21T23:46:24Z

⌛ Testing commit 55c02f6 with merge fc6f092...

@frewsxcv

Port the reference to mdbook Part of #39588. This is only a work in progress. Still left to do: - [x] double check contents weren't duplicated/lost with the move to individual pages (I'm going to do this) - [x] fix up links [and footnotes](#39855 (comment)) (@frewsxcv has volunteered to help with this) - [x] change `src/doc/reference.md` to redirect to the book - [x] move the reference on the doc index to be part of the bookshelf

bors · 2017-02-22T02:09:17Z

☀️ Test successful - status-appveyor, status-travis
Approved by: GuillaumeGomez
Pushing fc6f092 to master...

steveklabnik mentioned this pull request Feb 15, 2017
Tracking issue for RFC 1828: Rust Bookshelf #39588
Closed
10 tasks

steveklabnik force-pushed the mdbook-reference branch from b01076e to 8260a36Compare February 16, 2017 19:28

steveklabnik mentioned this pull request Feb 19, 2017
Generate links at compile-time rather than use JS rust-lang/mdBook#207
Merged

steveklabnik force-pushed the mdbook-reference branch from 8260a36 to 4aedf0bCompare February 20, 2017 13:14

steveklabnik mentioned this pull request Feb 20, 2017
Create the Unstable Book #39866
Merged
2 tasks

steveklabnik force-pushed the mdbook-reference branch from 4aedf0b to 021405eCompare February 20, 2017 22:28

steveklabnikand others added 3 commits February 21, 2017 14:00

Start the port of the reference to mdBook
c937254
This only really moves the files, there's a lot more work coming in the next commits. Part of rust-lang#39588.

clean up some things
287a345
I double checked that everything is here and in the correct order; this fixes things up

Introduction
c5cac87

frewsxcvand others added 19 commits February 21, 2017 14:01

Comments
94f3c1e

Tokens
c6275c4

Paths
49cea27

Macros
a486dcb

Macros By Example
b443c5e

Procedural macros
cdcc0f3

Crates and source files
d1f046f

Items and attributes
227aae3

influences
093380a

unsafety
ac4c55e

linkage
c0b40e1

Items
465a2bd

memory model
3de9619

types
0c5e17a

statements and expressions
4305b67

Get linkchecker clean
3eb8434
This affects the book, some missed things in the reference, the grammar, and the standard library. Whew!

Add footnote style.
9e95520
Until https://github.com/azerupi/mdBook/issues/210 is resolved, we'll import the css file.

Redirect to the new reference
54baed6

move the reference to the bookshelf
55c02f6

steveklabnik force-pushed the mdbook-reference branch from 37c4218 to 55c02f6Compare February 21, 2017 19:04

rust-highfive assigned GuillaumeGomez Feb 21, 2017

bors merged commit 55c02f6 into rust-lang:masterFeb 22, 2017

frewsxcv mentioned this pull request Feb 25, 2017
Reference doc: table of contents within a chapter #40087
Closed

Uh oh!

Uh oh!

Conversation

steveklabnik commented Feb 15, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Feb 15, 2017

Uh oh!

petrochenkov commented Feb 15, 2017

Uh oh!

steveklabnik commented Feb 15, 2017

Uh oh!

petrochenkov commented Feb 15, 2017

Uh oh!

steveklabnik commented Feb 15, 2017

Uh oh!

steveklabnik commented Feb 16, 2017

Uh oh!

bors commented Feb 16, 2017

Uh oh!

steveklabnik commented Feb 16, 2017

Uh oh!

steveklabnik commented Feb 16, 2017

Uh oh!

steveklabnik commented Feb 16, 2017

Uh oh!

steveklabnik commented Feb 17, 2017

Uh oh!

alexcrichton commented Feb 17, 2017

Uh oh!

alexcrichton commented Feb 17, 2017

Uh oh!

steveklabnik commented Feb 19, 2017

Uh oh!

steveklabnik commented Feb 19, 2017

Uh oh!

bors commented Feb 20, 2017

Uh oh!

steveklabnik commented Feb 20, 2017

Uh oh!

bors commented Feb 20, 2017

Uh oh!

steveklabnik commented Feb 20, 2017

Uh oh!

steveklabnik commented Feb 21, 2017

Uh oh!

steveklabnik commented Feb 21, 2017

Uh oh!

steveklabnik commented Feb 21, 2017

Uh oh!

steveklabnik commented Feb 21, 2017

Uh oh!

GuillaumeGomez commented Feb 21, 2017

Uh oh!

bors commented Feb 21, 2017

Uh oh!

bors commented Feb 21, 2017

Uh oh!

bors commented Feb 22, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

steveklabnik commented Feb 15, 2017•
edited
Loading