From 3ed78f5b6b5d85c9de5794dcf16cecf5d16f7864 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Mon, 23 Jun 2014 18:19:16 -0400 Subject: [PATCH] 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 --- configure | 1 + mk/docs.mk | 2 +- src/doc/guide.md | 10 ++++++++++ src/doc/tutorial.md | 7 +++++++ 4 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 src/doc/guide.md diff --git a/configure b/configure index fa87e5aa196..59aa6ece6b2 100755 --- a/configure +++ b/configure @@ -869,6 +869,7 @@ do make_dir $h/test/debuginfo-lldb make_dir $h/test/codegen make_dir $h/test/doc-tutorial + make_dir $h/test/doc-guide make_dir $h/test/doc-guide-ffi make_dir $h/test/doc-guide-runtime make_dir $h/test/doc-guide-macros diff --git a/mk/docs.mk b/mk/docs.mk index 68d4e19afa6..8098a0682a5 100644 --- a/mk/docs.mk +++ b/mk/docs.mk @@ -26,7 +26,7 @@ # L10N_LANGS are the languages for which the docs have been # translated. ###################################################################### -DOCS := index intro tutorial guide-ffi guide-macros guide-lifetimes \ +DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \ guide-tasks guide-container guide-pointers guide-testing \ guide-runtime complement-bugreport \ complement-lang-faq complement-design-faq complement-project-faq rust \ diff --git a/src/doc/guide.md b/src/doc/guide.md new file mode 100644 index 00000000000..59fb050556c --- /dev/null +++ b/src/doc/guide.md @@ -0,0 +1,10 @@ +% The Rust Guide + +
+This guide is a work in progress. Until it is ready, we highly recommend that +you read the Tutorial instead. This work-in-progress Guide is being +displayed here in line with Rust's open development policy. Please open any +issues you find as usual. +
+ +Coming soon. :) diff --git a/src/doc/tutorial.md b/src/doc/tutorial.md index 91556b81378..d5488ecc85d 100644 --- a/src/doc/tutorial.md +++ b/src/doc/tutorial.md @@ -1,5 +1,12 @@ % The Rust Language Tutorial +
+The tutorial is undergoing a complete re-write as the Guide. +Until it's ready, this tutorial is the right place to come to start learning +Rust. Please submit improvements as pull requests, but understand that +eventually it will be going away. +
+ # Introduction Rust is a programming language with a focus on type safety, memory -- 2.44.0