From 90c663682131a6cd7d44e4f0b29e158b5240eb27 Mon Sep 17 00:00:00 2001 From: Sergio Benitez Date: Sun, 16 Apr 2017 21:28:36 -0700 Subject: [PATCH] Remove duplication in site README. --- site/README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/site/README.md b/site/README.md index ea5491b5..b9e99edc 100644 --- a/site/README.md +++ b/site/README.md @@ -10,20 +10,18 @@ This directory contains the following: * `index.toml` - Source data for the index (`/`). * `news.toml` - Source data for the news page (`/news`). * `overview.toml` - Source data for the overview page (`/overview`). - * `guide.md` - Index page for the guide (`/guide`). + * `guide.md` - Index page for the [Rocket Programming Guide] (`/guide`). * `news/*.md` - News articles linked to from `news.toml`. * `guide/*.md` - Guide pages linked to from `guide.md`. -## Guide +[Rocket Programming Guide]: https://rocket.rs/guide/ -The source files for the [Rocket Programming Guide](https://rocket.rs/guide/) -can be found in the `guide/` directory. One exception is the root of the guide, -which is `guide.md`. +### Guide Links Cross-linking to pages in the guide is accomplished via absolute links rooted at -`/guide/`. To link to the page whose source is at `guide/page.md` in this -directory, for instance, link to `/guide/page`. +`/guide/`. To link to the page whose source is at `guide/page.md`, for instance, +link to `/guide/page`. -# License +## License The Rocket website source is licensed under the [GNU General Public License v3.0](LICENSE).