Skip to content

Commit 3ed78f5

Browse files
steveklabnikalexcrichton
authored andcommitted
Add the Guide, add warning to tutorial.
In line with what @brson, @cmr, @nikomatsakis and I discussed this morning, my redux of the tutorial will be implemented as the Guide. This way, I can work in small iterations, rather than dropping a huge PR, which is hard to review. In addition, the community can observe my work as I'm doing it. This adds a note in line with [this comment][reddit] that clarifies the state of the tutorial, and the community's involvement with it. [reddit]: http://www.reddit.com/r/rust/comments/28bew8/rusts_documentation_is_about_to_drastically/ci9c98k
1 parent c484c2d commit 3ed78f5

File tree

4 files changed

+19
-1
lines changed

4 files changed

+19
-1
lines changed

configure

+1
Original file line numberDiff line numberDiff line change
@@ -869,6 +869,7 @@ do
869869
make_dir $h/test/debuginfo-lldb
870870
make_dir $h/test/codegen
871871
make_dir $h/test/doc-tutorial
872+
make_dir $h/test/doc-guide
872873
make_dir $h/test/doc-guide-ffi
873874
make_dir $h/test/doc-guide-runtime
874875
make_dir $h/test/doc-guide-macros

mk/docs.mk

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# L10N_LANGS are the languages for which the docs have been
2727
# translated.
2828
######################################################################
29-
DOCS := index intro tutorial guide-ffi guide-macros guide-lifetimes \
29+
DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
3030
guide-tasks guide-container guide-pointers guide-testing \
3131
guide-runtime complement-bugreport \
3232
complement-lang-faq complement-design-faq complement-project-faq rust \

src/doc/guide.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
% The Rust Guide
2+
3+
<div style="border: 2px solid red; padding:5px;">
4+
This guide is a work in progress. Until it is ready, we highly recommend that
5+
you read the <a href="tutorial.html">Tutorial</a> instead. This work-in-progress Guide is being
6+
displayed here in line with Rust's open development policy. Please open any
7+
issues you find as usual.
8+
</div>
9+
10+
Coming soon. :)

src/doc/tutorial.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
% The Rust Language Tutorial
22

3+
<div style="border: 2px solid red; padding:5px;">
4+
The tutorial is undergoing a complete re-write as <a href="guide.html">the Guide</a>.
5+
Until it's ready, this tutorial is the right place to come to start learning
6+
Rust. Please submit improvements as pull requests, but understand that
7+
eventually it will be going away.
8+
</div>
9+
310
# Introduction
411

512
Rust is a programming language with a focus on type safety, memory

0 commit comments

Comments
 (0)