feat: Add book skeleton ✨

foresterre · Apr 25, 2024 · 2529d82 · 2529d82
1 parent 3413bdb
commit 2529d82
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 0 deletions.
diff --git a/book/.gitignore b/book/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/book/book.toml b/book/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Martijn Gribnau <[email protected]>"]
+language = "en"
+multilingual = false
+src = "src"
+title = "rust-releases"
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -0,0 +1,20 @@
+# Summary
+
+- [Introduction](./introduction.md)
+
+# Concepts
+
+- [rust-toolchain](./concepts_rust_toolchain.md)
+- [rust-releases](./concepts_rust_releases.md)
+
+# Sources
+
+- [rust-changelog](./sources_rust_changelog.md)
+- [rust-dist](./sources_rust_dist.md)
+- [rust-dist-cli (deprecated)](./sources_rust_dist_cli.md)
+- [rust-channel-manifests (deprecated)](./sources_rust_channel_manifests.md)
+  [//]: # (- Future: github-rust-releases)
+
+# Developer Resources
+
+- [Resources](./developer_resources.md)
diff --git a/book/src/concepts_rust_releases.md b/book/src/concepts_rust_releases.md
@@ -0,0 +1 @@
+# rust-releases
diff --git a/book/src/concepts_rust_toolchain.md b/book/src/concepts_rust_toolchain.md
@@ -0,0 +1 @@
+# rust-toolchain
diff --git a/book/src/developer_resources.md b/book/src/developer_resources.md
@@ -0,0 +1,24 @@
+# Useful resources
+
+## Forge
+
+- [Forge Home](https://forge.rust-lang.org/)
+- [Rust Release Channel Layout](https://forge.rust-lang.org/infra/channel-layout.html)
+- [Rust "Other installation methods"](https://forge.rust-lang.org/infra/other-installation-methods.html)
+
+## Rustup
+
+- [on Channels](https://rust-lang.github.io/rustup/concepts/channels.html)
+- [on Toolchains](https://rust-lang.github.io/rustup/concepts/toolchains.html)
+- [on Components](https://rust-lang.github.io/rustup/concepts/components.html)
+- [on Profiles](https://rust-lang.github.io/rustup/concepts/profiles.html)
+- [Environment Variables](https://rust-lang.github.io/rustup/environment-variables.html)
+
+## Rust on GitHub
+
+- [RELEASES.md: Rust changelog](https://raw.githubusercontent.com/rust-lang/rust/master/RELEASES.md)
+
+## Misc
+
+- [Rustup Components History](https://rust-lang.github.io/rustup-components-history/index.html) by Nightly version and
+  target
diff --git a/book/src/introduction.md b/book/src/introduction.md
@@ -0,0 +1,10 @@
+# Introduction
+
+Welcome! This is a book intended to document the [rust-releases](https://github.com/foresterre/rust-releases/) project.
+It's a bit empty right now. Check back in the future!
+
+For additional documentation, you may find the following resources useful:
+
+- [docs.rs/rust-releases](https://docs.rs/rust-releases/): library docs
+- [github.com/foresterre/rust-releases](https://github.com/foresterre/rust-releases/): crate introduction and
+  documentation in the readme
diff --git a/book/src/sources_rust.md b/book/src/sources_rust.md
@@ -0,0 +1 @@
+# rust-dist
diff --git a/book/src/sources_rust_changelog.md b/book/src/sources_rust_changelog.md
@@ -0,0 +1 @@
+# rust-changelog
diff --git a/book/src/sources_rust_channel_manifests.md b/book/src/sources_rust_channel_manifests.md
@@ -0,0 +1 @@
+# rust-channel-manifests
diff --git a/book/src/sources_rust_dist.md b/book/src/sources_rust_dist.md
@@ -0,0 +1 @@
+# rust-dist
diff --git a/book/src/sources_rust_dist_cli.md b/book/src/sources_rust_dist_cli.md
@@ -0,0 +1 @@
+# rust-dist