OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add the Guide, add warning to tutorial.

Browse Source 
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
This commit is contained in:
Steve Klabnik 2014-06-23 18:19:16 -04:00 committed by Alex Crichton
parent c484c2d1f8
commit 3ed78f5b6b
4 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
configure vendored
View File

@ -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

2
mk/docs.mk
View File

@ -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 \

10
src/doc/guide.md Normal file
View File

@ -0,0 +1,10 @@
% The Rust Guide
<div style="border: 2px solid red; padding:5px;">
This guide is a work in progress. Until it is ready, we highly recommend that
you read the <a href="tutorial.html">Tutorial</a> 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.
</div>
Coming soon. :)

7
src/doc/tutorial.md
View File

@ -1,5 +1,12 @@
% The Rust Language Tutorial
<div style="border: 2px solid red; padding:5px;">
The tutorial is undergoing a complete re-write as <a href="guide.html">the Guide</a>.
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.
</div>
# Introduction
Rust is a programming language with a focus on type safety, memory