rust-embedded / rust-embedded.github.io

A collection of books and other documents about embedded Rust
https://docs.rust-embedded.org
Apache License 2.0
84 stars 8 forks source link

Canonical domain for books #23

Open markhildreth opened 4 years ago

markhildreth commented 4 years ago

For each book, there are a variety of URLs that can be used to access some version of the book. For example, the discovery book can be "found" under the following URLs:

Since https://github.com/rust-embedded/wg/issues/208, the goal has been to host them all under docs.rust-embedded.org. However, there are inconsistencies, which in some cases cause poor SEO, in others can confusion and updated content to never reach users. I have tried to find these problems that are easy to fix and list them in one place, creating and/or linking to issues to any issues that should be resolved.

Discovery Book

Canonical URL: https://docs.rust-embedded.org/discovery/ Repo: https://github.com/rust-embedded/discovery

Embedded Book

Canonical URL: https://docs.rust-embedded.org/book/ Repo: https://github.com/rust-embedded/book

Embedonomicon

Canonical URL: https://docs.rust-embedded.org/embedonomicon/ Repo: https://github.com/rust-embedded/embedonomicon

Additional Info

Currently, links using the correct domain might still use different paths, such as...

I'm not too worried about these for now, but it might be nice to have a better canonical link system. See https://github.com/rust-lang/mdBook/issues/1238 for more.