rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Rocket/site
History
Sergio Benitez 9671115796 Use 'workers' value from 'Config::figment()'. 
This commit also improves config pretty-printing and warning messages.
It also fixes an issue that resulted in config value deprecation
warnings not being emitted. The 'workers' value is now a 'usize', not a
'u16'; contrib pool sizes now default to 'workers * 2'.

Closes #1470.
 		2020-12-24 15:58:48 -08:00
..
guide Use 'workers' value from 'Config::figment()'. 2020-12-24 15:58:48 -08:00
news Fix various typos throughout the codebase. 2020-07-22 12:56:01 -07:00
tests Use 'workers' value from 'Config::figment()'. 2020-12-24 15:58:48 -08:00
LICENSE Add site contents, including the guide. Add license information. 2017-04-16 21:11:41 -07:00
README.md Point all docs and doc links to 'master' branch. 2020-10-21 04:54:24 -07:00
index.toml Point all docs and doc links to 'master' branch. 2020-10-21 04:54:24 -07:00
overview.toml Add '#[rocket::launch]' attribute. 2020-07-11 09:24:29 -07:00

README.md

Rocket Website Source

This directory contains the source files for the content on Rocket's website.

Contents

This directory contains the following:

  • index.toml - Source data for the index.
  • overview.toml - Source data for the overview page (overview/).
  • news/index.toml - Source data for the news page (news/).
  • news/*.md - News articles linked to from news/index.toml.
  • guide/*.md - Guide pages linked to from guide.md.

Guide Links

Cross-linking guide pages is accomplished via relative links. Outside of the index, this is: ../{page}#anchor. For instance, to link to the Quickstart > Running Examples page, use ../quickstart#running-examples.

Aliases

Aliases are shorthand URLs that start with @ (e.g, @api). They are used throughout the guide to simplify versioning URLs to Rocket's source code and the Rocket API. They are replaced at build time with a URL prefix. At present, the following aliases are available, where ${version} is Rocket's version string at the time of compilation:

For example, to link to Rocket::launch(), you might write:

Launch an instance of your application using the [`launch()`] method.

[`launch()`]: @api/rocket/struct.Rocket.html#method.launch

License

The Rocket website source is licensed under the GNU General Public License v3.0.