Commit Graph

40 Commits

Author SHA1 Message Date
Josh Triplett 84779866ff
Links from rustc-dev-guide to std-dev-guide (#1152) 2021-07-01 13:19:06 +02:00
Yuki Okushi 6448a3ebdd Replace some Travis-related things completely 2021-04-27 13:15:39 -04:00
Iñaki Garay bee2fd52ce
Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
saki-osive 7ea20079df
Corrected MIR file path and fixed a typo (#1020) 2021-01-14 14:10:08 -08:00
Joshua Nelson e66adf6bb5
Improve contributor experience for the dev-guide itself (#973)
- Fix typos in the README
- Don't echo all instructions in the linkcheck.sh shellscript; this is
  noisy and unhelpful when developing locally. Verbose output is still
  enabled in CI.
- Link to the index page for compiler docs, not `rustc_middle`. Note
  that the compiler docs are not a guide - that's us!
- Remove outdated instructions about avoiding 429s. These should no
  longer be occurring locally now that we're using caching.
- Consolidate info about `mdbook` and `mdbook-linkcheck` near each other
2020-11-30 11:08:32 -03:00
Camelid db9070f699 Mention you will need recent versions of mdbook* 2020-10-11 17:51:07 -04:00
Camelid 60808ea520 Use official mdbook-linkcheck version
We were using an alpha version before, pinned to a Git hash, so that we
could access a new feature (Michael-F-Bryan/mdbook-linkcheck#42).

Now there is a point release though (0.7.1), so we can update to that!
2020-10-11 17:51:07 -04:00
LeSeulArtichaut 30d4a42313 Update installation instructions for `mdbook-linkcheck` 2020-10-10 12:39:19 -04:00
Joshua Nelson c58ff8dc09 Fix incorrect windows link
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-10-01 01:27:11 -04:00
Joshua Nelson 8aaf8edf21 Add windows instructions 2020-10-01 01:27:11 -04:00
Joshua Nelson 4a6fd1131b Recommend setting up `check_line_lengths` as a pre-commit script
I've run into lots of annoying failures from this.

- Make it runnable without arguments
- Add it in the README
2020-10-01 01:27:11 -04:00
Yuki Okushi 5d8a8c832b Address review comment 2020-08-02 08:38:26 -05:00
Yuki Okushi c7a3bca829 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Joshua Nelson eeca3757b8
Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Who? Me?! 37117d5ad6 Make travis badge link to travis 2020-06-02 19:46:12 -05:00
Chris Simpkins 7b9fa81800 [README.md] add build instructions, link check config instructions, link check error documentation 2020-04-04 12:07:30 -05:00
LeSeulArtichaut 83cd94ed2b Rename `librustc` to `librustc_middle` 2020-03-31 15:43:14 -05:00
Santiago Pastorino 66be765404
Rename rustc-guide to rustc-dev-guide (#601)
* Rename rustc-guide to rustc-dev-guide

* rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
2020-03-10 11:01:43 -03:00
LeSeulArtichaut c6211a375f Spell `Voilà` properly in README.md 2020-03-02 16:26:27 -06:00
Who? Me?! 0dde43f579 Update README 2020-02-02 23:53:39 -06:00
Who? Me?! 4729cfe485 Add travis badge to README 2019-11-05 11:59:04 -06:00
Tshepang Lekhonkhobe fa3a3e4d5d I prefers long options in documentation 2019-10-17 23:14:34 -05:00
Yuki Okushi 2d5a47f2cd Add guidance for making a PR fixes toolstate 2019-09-19 20:21:14 -05:00
Who? Me?! 733c435f16 add some instructions to fix toolstate (#446) 2019-09-18 09:50:39 -03:00
Yuki Okushi fb3bf19590 Move into rust-lang 2019-07-17 10:40:33 -05:00
Who? Me?! e900144d75
Typo + minor edits 2019-01-18 14:36:52 -06:00
Avelino 022d3f4b56 fixed typo issues link 2018-12-05 16:54:58 -06:00
Andy Wortman a18f366010 fix some linkrotted links 2018-12-01 21:57:43 -06:00
mark 7cf032f9ec Update a few parts of the readme 2018-10-13 11:35:53 -05:00
Mark Mansi f013b867c5 update readme 2018-09-21 15:54:25 -05:00
Mark Mansi 5e7d9f6b42 update readme with mdbook version 2018-09-21 15:54:25 -05:00
mark 37a202cdba fix all the not-en-dashes 2018-07-09 21:45:49 -05:00
mark 7fe7f7401c add a link to the rustc docs 2018-07-05 09:21:45 -05:00
varkor 43341c8894 Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Who? Me?! dc037e216b
Update README.md 2018-02-04 16:11:19 -06:00
Michael Bryan 79052b4aca Added a note about how to use mdbook-linkcheck 2018-01-31 14:13:10 -05:00
Niko Matsakis 54145323f8 add link to gh-pages 2018-01-17 09:53:45 -05:00
Niko Matsakis 78960d989a improve the README 2018-01-17 09:25:23 -05:00
Jonathan Turner 647b8663d1
Update README.md 2018-01-17 13:13:13 +13:00
Niko Matsakis 35b1429fe3 add code-of-conduct, licensing material, and a README 2018-01-16 16:36:21 -05:00