rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-21 01:39:07 +02:00
Code Issues Releases Activity
95eb00be5d
comprehensive-rust/book.toml

290 lines
15 KiB
TOML
Raw Normal View History

Publish Comprehensive Rust šŸ¦€
2022-12-21 17:36:30 +02:00
[book]
authors = ["Martin Geisler"]
language = "en"
multilingual = false
src = "src"
title = "Comprehensive Rust šŸ¦€"
[rust]
edition = "2021"
Watch `po/` directory for changes (#188) This makes `mdbook serve` automatically reload the page when translations change.
2023-01-20 12:36:14 +02:00
[build]
Integrate GA4 code directly with `book.js` (#470) * Integrate GA4 code directly with `book.js` The main advantage of this is that it simplifies the setup since we can avoid the monkey-patching we did before. A secondary advantage is that it should make things a little faster since we avoid a request to the server on every page load. * Remove unreachable return * Watch all of `third_party` It just occurred to me that we want to refresh the page in `mdbook serve` when anything changes in `third_party`.
2023-03-02 19:50:37 +02:00
extra-watch-dirs = ["po", "third_party"]
Watch `po/` directory for changes (#188) This makes `mdbook serve` automatically reload the page when translations change.
2023-01-20 12:36:14 +02:00
Make `i18n-helpers` a requirement (#461) * Make i18n-helpers a requirement * Skip mdbook-gettext for mdbook-xgettext * Gettext finds PO file based on `book.language` * Update workflow No need to set `preprocessor.gettext.po-file`. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-02-28 15:05:09 +02:00
[preprocessor.gettext]
Remove `renderers` from `links` and `index` preprocessors (#464) * Remove `renderers` from `links` and `index` preprocessors These two preprocessors are default preprocessors and controlled by `build.use_default_preprocessors` not by `renders`. * Fix the order of preprocessors I was wrong about the order in #461. * Remove `links` and `index` preprocessor lines These default preprocessors are run by default. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-03-02 11:01:24 +02:00
after = ["links"]
Add support for translations This implements a translation pipeline using the industry-standard Gettext[1] system. I picked Gettext for the reasons described in [2] and [3]: * Itā€™s widely used in open source software. This means that there are graphical editors which will help you in editing the `.po` files. An example is Poedit[4], which is available for all major platforms. There are also many online systems for doing translations. An example is Pontoon[5], which is used for the Rust website itself. We can consider setting up such an instance ourselves. * It is a light-weight yet structured format. This means that nothing changes with regards to how you update the original English text. We can still accept fixes and PRs like normal. The structure means that translators can see exactly which part of the course they need to update after a change. This is completely lost if you simply copy over the original text and translate it in-place in the Markdown files. The code here only adds support for translations. They are not yet tested, published or used for anything. Next steps will be: * Add support for switching languages via a bit of JavaScript on each page. * Update the speaker notes feature to support translations (right now ā€œSpeaker Notesā€ is hard-coded into the generated HTML). I think we should turn it into a mdbook preprocessor instead. * Add testing: We should test that the `.po` files are well-formed. We should also run `mdbook test` on each language since the translations can alter the embedded code. Fixes #115. [1]: https://www.gnu.org/software/gettext/manual/html_node/index.html [2]: https://github.com/rust-lang/mdBook/pull/1864 [3]: https://github.com/rust-lang/mdBook/issues/5#issuecomment-1144887806 [4]: https://poedit.net/ [5]: https://pontoon.rust-lang.org/
2023-01-08 14:45:19 +02:00
Publish Comprehensive Rust šŸ¦€
2022-12-21 17:36:30 +02:00
[preprocessor.svgbob]
Add support for translations This implements a translation pipeline using the industry-standard Gettext[1] system. I picked Gettext for the reasons described in [2] and [3]: * Itā€™s widely used in open source software. This means that there are graphical editors which will help you in editing the `.po` files. An example is Poedit[4], which is available for all major platforms. There are also many online systems for doing translations. An example is Pontoon[5], which is used for the Rust website itself. We can consider setting up such an instance ourselves. * It is a light-weight yet structured format. This means that nothing changes with regards to how you update the original English text. We can still accept fixes and PRs like normal. The structure means that translators can see exactly which part of the course they need to update after a change. This is completely lost if you simply copy over the original text and translate it in-place in the Markdown files. The code here only adds support for translations. They are not yet tested, published or used for anything. Next steps will be: * Add support for switching languages via a bit of JavaScript on each page. * Update the speaker notes feature to support translations (right now ā€œSpeaker Notesā€ is hard-coded into the generated HTML). I think we should turn it into a mdbook preprocessor instead. * Add testing: We should test that the `.po` files are well-formed. We should also run `mdbook test` on each language since the translations can alter the embedded code. Fixes #115. [1]: https://www.gnu.org/software/gettext/manual/html_node/index.html [2]: https://github.com/rust-lang/mdBook/pull/1864 [3]: https://github.com/rust-lang/mdBook/issues/5#issuecomment-1144887806 [4]: https://poedit.net/ [5]: https://pontoon.rust-lang.org/
2023-01-08 14:45:19 +02:00
renderers = ["html"]
Remove `renderers` from `links` and `index` preprocessors (#464) * Remove `renderers` from `links` and `index` preprocessors These two preprocessors are default preprocessors and controlled by `build.use_default_preprocessors` not by `renders`. * Fix the order of preprocessors I was wrong about the order in #461. * Remove `links` and `index` preprocessor lines These default preprocessors are run by default. --------- Co-authored-by: Jooyung Han <jooyung@google.com>
2023-03-02 11:01:24 +02:00
after = ["gettext"]
Publish Comprehensive Rust šŸ¦€
2022-12-21 17:36:30 +02:00
class = "bob"
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
[preprocessor.course]
mdbook-course: Make printing summary optional (#1562) There is now a new ā€œverboseā€ setting which can be used to print the summary when desired.
2023-12-06 19:57:18 +02:00
verbose = false # Report timing information.
Render book as PDF in `publish.yml` workflow (#1572) Renders the book as a PDF and includes it in the published HTML bundle as `comprehensive-rust.pdf`. Closes #1543
2024-01-16 00:02:05 +02:00
[output.pandoc]
optional = true
Upgrade `mdbook-pandoc` and disable it except during CI workflows (#2212) Implements the approach summarized in https://github.com/google/mdbook-i18n-helpers/issues/200#issuecomment-2220035461 to disable running `mdbook-pandoc` even if it is available to avoid dependency-related issues during local rendering. Should address https://github.com/google/comprehensive-rust/issues/1911 since `mdbook-pandoc` will no longer run locally.
2024-07-18 13:01:25 +02:00
disabled = true
Rendered PDF improvements (#1805) Updates `mdbook-pandoc` to [0.5.0](https://github.com/max-heller/mdbook-pandoc/releases/tag/v0.5.0) to use some new features: - Table wrapping (closes #1709) The wrapping logic mirror's [Pandoc's](https://pandoc.org/MANUAL.html#extension-pipe_tables) (i.e., compare the relative widths of the `---` columns to determine column widths) so tables in the source may need tweaking to get the proportions right - Replace broken links in PDF with corresponding links to https://google.github.io/comprehensive-rust/
2024-02-20 12:04:30 +02:00
hosted-html = "https://google.github.io/comprehensive-rust/"
Render book as PDF in `publish.yml` workflow (#1572) Renders the book as a PDF and includes it in the published HTML bundle as `comprehensive-rust.pdf`. Closes #1543
2024-01-16 00:02:05 +02:00
[output.pandoc.profile.pdf]
output-file = "comprehensive-rust.pdf"
pdf-engine = "lualatex"
[output.pandoc.profile.pdf.variables]
mainfont = "Noto Serif"
sansfont = "Noto Sans"
monofont = "Noto Sans Mono"
set fallback fonts for PDF rendering (#1728) Once a new version of Pandoc is released that includes https://github.com/jgm/pandoc/pull/9204 and https://github.com/jgm/pandoc/pull/9353 (both merged), this will fix the emoji and symbol rendering issues in #1708. It doesn't seem to be possible to set fallback fonts with `luatexja-fontspec` (used to configure CJK fonts), which results in some missing symbols in the translations but at least renders the emoji properly. Closes #1708
2024-03-07 15:37:52 +02:00
mainfontfallback = ["NotoColorEmoji:mode=harf"]
monofontfallback = [
"NotoColorEmoji:mode=harf",
"NotoSansMath:",
"NotoSansMonoCJKSC:",
]
Render book as PDF in `publish.yml` workflow (#1572) Renders the book as a PDF and includes it in the published HTML bundle as `comprehensive-rust.pdf`. Closes #1543
2024-01-16 00:02:05 +02:00
geometry = ["margin=1.25in"]
linkcolor = "blue"
urlcolor = "red"
Publish Comprehensive Rust šŸ¦€
2022-12-21 17:36:30 +02:00
[output.html]
Fix a broken link and check internal links (#2195) In #2153 I aimed to fix a link but broke it. In this PR, I fix it and add [`mdbook-linkcheck`](https://github.com/Michael-F-Bryan/mdbook-linkcheck) to avoid future cases. Some past fixes that could have been prevented, in addition to mine in this PR: * #811 * #2064 * #2146 Note: `mdbook-linkcheck` may also check external links with a configuration change. It can be beneficial to check also external links from time to time. I ran it here and found 3 broken links. Maintainers - sorry for the lack of a preceding issue. We can discuss it here. Some remaining work is to fix the outdated internal links in the translations, not done here. Let me know what you think about the proposed contribution. This PR completes #1502.
2024-07-22 13:37:19 +02:00
smart-punctuation = true
Saving playground code state (#1917) The embedded Playground's code reset when you navigate between slides. This has caused problems: if people navigate away from a slide to look something up, they've suddenly lost their work.
2024-03-22 18:15:54 +02:00
additional-js = [
"theme/speaker-notes.js",
]
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
additional-css = [
Move CSS files into `theme/` folder (#1229) Hi all, This PR fixes https://github.com/google/comprehensive-rust/issues/1226: * Moved CSS files to `theme/css` * Moved speaker-notes.js to `theme/` * Updated paths in book.toml
2023-09-21 11:00:27 +02:00
"theme/css/svgbob.css",
Add a dev theme to help with slide aspect ratio (#1842) Added a dev theme to help with slide aspect ratio while updating content or for reviewing PRs. Fixes #1796. --------- Co-authored-by: Dustin J. Mitchell <djmitche@google.com> Co-authored-by: Martin Geisler <martin@geisler.net>
2024-03-05 12:33:42 +02:00
"theme/css/redbox.css",
Move CSS files into `theme/` folder (#1229) Hi all, This PR fixes https://github.com/google/comprehensive-rust/issues/1226: * Moved CSS files to `theme/css` * Moved speaker-notes.js to `theme/` * Updated paths in book.toml
2023-09-21 11:00:27 +02:00
"theme/css/speaker-notes.css",
"theme/css/language-picker.css",
Fixture code and footer content tags in rtl content (#1433) Part of #671 and #1413 In the code part of content which always is in english and must be `text-align: left` but with `<html ... dir=rtl >` cuz conflict. --------- Co-authored-by: Kaveh <hamidrkp@riseup.net>
2023-10-31 08:37:04 +02:00
"theme/css/rtl.css",
Add mdbook-course to handle parsing frontmatter (#1224) In v2 of the course, I'd like to include an estimate of the time to be spent on each segment in the Markdown file. I think a good place for such metadata is in the frontmatter. For review purposes, though, I just want to display that information. So, this is a start at a new mdbook preprocessor that just separates out the frontmatter and includes it in a `<pre>` block. Eventually, I'd like to parse it and put the time in the speaker notes. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2023-09-20 16:01:53 +02:00
]
Set the site-url to fix 404 page on GitHub Pages (#263) This fixes the 404 page on GitHub Pages: the default is `/`, but weā€™re hosting the site from a subdirectory because of how the repository is setup. Fixes #178.
2023-01-24 13:03:46 +02:00
site-url = "/comprehensive-rust/"
Link back to repository in top-right corner
2022-12-21 18:28:02 +02:00
git-repository-url = "https://github.com/google/comprehensive-rust"
Add links to edit every page on GitHub This makes it super easy to edit a page: just click the icon in the top-right and youā€™ll be taken directly to an editor on GitHub.
2022-12-21 18:29:56 +02:00
edit-url-template = "https://github.com/google/comprehensive-rust/edit/main/{path}"
Publish Comprehensive Rust šŸ¦€
2022-12-21 17:36:30 +02:00
[output.html.fold]
enable = true
level = 0
[output.html.playground]
editable = true
Display line numbers for code examples (#664) This makes it easier to refer to a specific line of code while teaching or collaborating on a code snippet.
2023-05-24 09:25:18 +02:00
line-numbers = true
Setup redirects after #120 and #177 (#352) This makes `mdbook` output a simple redirect at the location of the old pages. Iā€™ll try to add such pages when we shuffle around our pages to make sure external links stay valid.
2023-02-06 18:10:01 +02:00
Fix `mdbook` redirection table (#1567) There must have been a merge conflict at some point which resulted in a malformed table. The result was that most redirects were blindly ignored by `mdbook`. I noticed it for https://google.github.io/comprehensive-rust/enums.html which stopped working because of this. I took out the memory management redirect since we already have a file where redirect would be (`mdbook` helpfully emits an error in this case).
2023-12-07 17:51:42 +02:00
[output.html.search]
use-boolean-and = true
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
# Redirects in the form of "old-path" = "new-path", where the new path
# is relative to the old path.
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
#
# Please keep the table sorted and avoid multi-step redirects.
[output.html.redirect]
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"async/async-await.html" = "../concurrency/async/async-await.html"
"async/channels.html" = "../concurrency/async-control-flow/channels.html"
Add redirect for old async/concurrency/ directory (#635) It seems we had a link to async/concurrency/channels.html for a brief period. This got indexed and now show up as 404 errors in my reports.
2023-05-15 16:05:28 +02:00
"async/concurrency/channels.html" = "../channels.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"async/control-flow/join.html" = "../concurrency/async-control-flow/join.html"
"async/control-flow/select.html" = "../concurrency/async-control-flow/select.html"
"async/futures.html" = "../concurrency/async/futures.html"
"async.html" = "concurrency/welcome-async.html"
"async/pitfall/async-traits.html" = "../async-pitfalls/async-traits.html"
"async/pitfalls/async-traits.html" = "../concurrency/async-pitfalls/async-traits.html"
"async/pitfalls/blocking-executor.html" = "../concurrency/async-pitfalls/blocking-executor.html"
"async/pitfalls/cancellation.html" = "../concurrency/async-pitfalls/cancellation.html"
"async/pitfalls.html" = "../concurrency/async-pitfalls.html"
"async/pitfalls/pin.html" = "../concurrency/async-pitfalls/pin.html"
"async/runtimes.html" = "../concurrency/async/runtimes.html"
"async/runtimes/tokio.html" = "../concurrency/async/runtimes/tokio.html"
"async/tasks.html" = "../concurrency/async/tasks.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"basic-syntax/compound-types.html" = "../tuples-and-arrays/tuples-and-arrays.html"
"basic-syntax/functions.html" = "../control-flow-basics/functions.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"basic-syntax/functions-interlude.html" = "../control-flow-basics/functions.html"
"basic-syntax.html" = "control-flow-basics.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"basic-syntax/methods.html" = "../control-flow-basics/functions.html"
"basic-syntax/references-dangling.html" = "../references/shared.html"
"basic-syntax/references.html" = "../references/shared.html"
"basic-syntax/rustdoc.html" = "../std-types/docs.html"
"basic-syntax/scalar-types.html" = "../types-and-values/values.html"
"basic-syntax/scopes-shadowing.html" = "../control-flow-basics/blocks-and-scopes.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"basic-syntax/slices.html" = "../references/slices.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"basic-syntax/static-and-const.html" = "../unsafe-rust/static-and-const.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"basic-syntax/string-slices.html" = "../references/strings.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"basic-syntax/type-inference.html" = "../types-and-values/inference.html"
"basic-syntax/variables.html" = "../types-and-values/variables.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"concurrency.html" = "concurrency/welcome.html"
"concurrency/scoped-threads.html" = "threads/scoped.html"
"concurrency/shared_state/arc.html" = "../shared-state/arc.html"
"concurrency/shared_state/example.html" = "../shared-state/example.html"
"concurrency/shared_state.html" = "shared-state.html"
"concurrency/shared_state/mutex.html" = "../shared-state/mutex.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"control-flow-basics/conditionals.html" = "if.html"
"control-flow/blocks.html" = "../control-flow-basics/blocks-and-scopes.html"
"control-flow/break-continue.html" = "../control-flow-basics/break-continue.html"
"control-flow/for-expressions.html" = "../control-flow-basics/loops.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"control-flow.html" = "control-flow-basics.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"control-flow/if-expressions.html" = "../control-flow-basics/conditionals.html"
"control-flow/if-let-expressions.html" = "../pattern-matching/let-control-flow.html"
"control-flow/loop-expressions.html" = "../control-flow-basics/loops.html"
"control-flow/match-expressions.html" = "../tuples-and-arrays/match.html"
"control-flow/novel.html" = "../pattern-matching/let-control-flow.html"
"control-flow/while-expressions.html" = "../control-flow-basics/loops.html"
Fix broken link in for-expressions.md (#812)
2023-06-13 19:43:08 +02:00
"control-flow/while-let-expression.html" = "while-let-expressions.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"control-flow/while-let-expressions.html" = "../pattern-matching/let-control-flow.html"
"enums.html" = "user-defined-types/enums.html"
"enums/sizes.html" = "../user-defined-types/enums.html"
"enums/variant-payloads.html" = "../user-defined-types/enums.html"
"error-handling/converting-error-types-example.html" = "../error-handling/try-conversions.html"
"error-handling/converting-error-types.html" = "../error-handling/try-conversions.html"
"error-handling/deriving-error-enums.html" = "../error-handling/error.html"
"error-handling/dynamic-errors.html" = "../error-handling/thiserror-and-anyhow.html"
"error-handling/error-contexts.html" = "../error-handling/thiserror-and-anyhow.html"
"error-handling/panic-unwind.html" = "../error-handling/panics.html"
"error-handling/try-operator.html" = "../error-handling/try.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"exercises/concurrency/afternoon.html" = "../../concurrency/async-exercises.html"
"exercises/concurrency/chat-app.html" = "../../concurrency/async-exercises/chat-app.html"
"exercises/concurrency/dining-philosophers-async.html" = "../../concurrency/async-exercises/dining-philosophers.html"
"exercises/concurrency/dining-philosophers.html" = "../../concurrency/sync-exercises/dining-philosophers.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"exercises/concurrency/elevator.html" = "chat-app.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"exercises/concurrency/link-checker.html" = "../../concurrency/sync-exercises/link-checker.html"
"exercises/concurrency/morning.html" = "../../concurrency/sync-exercises.html"
"exercises/concurrency/solutions-afternoon.html" = "../../concurrency/async-exercises/solutions.html"
"exercises/concurrency/solutions-morning.html" = "../../concurrency/sync-exercises/solutions.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"exercises/day-1/afternoon.html" = "../../control-flow-basics/exercise.html"
"exercises/day-1/book-library.html" = "../day-2/book-library.html"
"exercises/day-1/for-loops.html" = "../../tuples-and-arrays/exercise.html"
"exercises/day-1/implicit-conversions.html" = "../../std-traits/exercise.html"
"exercises/day-1/iterators-and-ownership.html" = "../day-2/iterators-and-ownership.html"
"exercises/day-1/luhn.html" = "../../testing/exercise.html"
"exercises/day-1/morning.html" = "../../control-flow-basics/exercise.html"
"exercises/day-1/pattern-matching.html" = "../../user-defined-types/exercise.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"exercises/day-1/soluƧƵes-tarde.html" = "solutions-afternoon.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"exercises/day-2/afternoon.html" = "../../control-flow-basics/exercise.html"
"exercises/day-2/book-library.html" = "../../std-types/exercise.html"
"exercises/day-2/health-statistics.html" = "../../borrowing/exercise.html"
"exercises/day-2/iterators-and-ownership.html" = "../../iterators/intoiterator.html"
"exercises/day-2/luhn.html" = "../day-1/luhn.html"
"exercises/day-2/morning.html" = "../../control-flow-basics/exercise.html"
"exercises/day-2/points-polygons.html" = "../day-3/points-polygons.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"exercises/day-2/soluƧƵes-tarde.html" = "solutions-afternoon.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"exercises/day-2/strings-iterators.html" = "../../iterators/exercise.html"
"exercises/day-3/afternoon.html" = "../../control-flow-basics/exercise.html"
"exercises/day-3/morning.html" = "../../control-flow-basics/exercise.html"
"exercises/day-3/points-polygons.html" = "../../references/exercise.html"
"exercises/day-3/safe-ffi-wrapper.html" = "../../unsafe-rust/exercise.html"
"exercises/day-3/simple-gui.html" = "../../methods-and-traits/exercise.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"exercises/day-3/simples-gui.html" = "simple-gui.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"exercises/day-3/soluƧƵes-tarde.html" = "solutions-afternoon.html"
Fix page redirects (#620) * Fix broken redirects A few of these were wrong since they assumed the target path is relative to the root of the course (the path is relative to the page being redirected). * Sort redirects
2023-05-08 16:31:54 +02:00
"exercises/day-4/afternoon.html" = "../android/morning.html"
"exercises/day-4/android.html" = "../android/morning.html"
"exercises/day-4/dining-philosophers.html" = "../concurrency/dining-philosophers.html"
"exercises/day-4/elevator.html" = "../concurrency/elevator.html"
"exercises/day-4/link-checker.html" = "../concurrency/link-checker.html"
"exercises/day-4/morning.html" = "../concurrency/morning.html"
"exercises/day-4/solutions-morning.html" = "../concurrency/solutions-morning.html"
"generics/closures.html" = "../traits/closures.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"generics/data-types.html" = "../generics/generic-data.html"
"generics/methods.html" = "../generics/generic-data.html"
"generics/monomorphization.html" = "../generics/generic-functions.html"
Fix broken link to trait objects (#633)
2023-05-15 16:06:50 +02:00
"generics/trait-objects.html" = "../traits/trait-objects.html"
fix mdbook redirection table (#1635) Link `overloading` in Speaker note in URL: https://google.github.io/comprehensive-rust/hello-world/hello-world.html is broken. - broken: https://google.github.io/comprehensive-rust/hello-world/basic-syntax/functions-interlude.html (404) - correct: https://google.github.io/comprehensive-rust/control-flow-basics/functions.html The reason why it is broken is below. Original markdown is here https://github.com/google/comprehensive-rust/blob/43474d27d1276e8a88307a1686ee3f36cd77cf7f/src/hello-world/hello-world.md?plain=1#L36-L37 ``` [overloading](basic-syntax/functions-interlude.md) ``` Page path is `/hello-world/hello-world.html`, so overloading link become `/hello-world/basic-syntax/functions-interlude.html`, which is 404. I feel it is better to use redirect to exact path, so I edit `book.toml` and make link redirect to `/basic-syntax/functions-interlude.html`, which re-redirect to path `/control-flow-basics/functions.html` https://github.com/google/comprehensive-rust/blob/43474d27d1276e8a88307a1686ee3f36cd77cf7f/book.toml#L114
2024-01-04 16:05:49 +02:00
"hello-world/basic-syntax/functions-interlude.html" = "../../control-flow-basics/functions.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"hello-world/hello-world.html" = "../types-and-values/hello-world.html"
"memory-management/manual.html" = "../memory-management/approaches.html"
"memory-management/rust.html" = "../memory-management/ownership.html"
"memory-management/scope-based.html" = "../memory-management/approaches.html"
"memory-management/stack.html" = "../memory-management/review.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"memory-management/stack-vs-heap.html" = "../memory-management/review.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"methods-and-traits/trait-objects.html" = "../smart-pointers/trait-objects.html"
"methods/example.html" = "../methods-and-traits/methods.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"methods.html" = "methods-and-traits/methods.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"methods/receiver.html" = "../methods-and-traits/methods.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"outros-recursos.html" = "other-resources.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"ownership/borrowing.html" = "../borrowing/shared.html"
"ownership/copy-clone.html" = "../memory-management/copy-types.html"
"ownership/double-free-modern-cpp.html" = "../memory-management/move.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"ownership.html" = "memory-management/ownership.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"ownership/lifetimes-data-structures.html" = "../lifetimes/struct-lifetimes.html"
"ownership/lifetimes-function-calls.html" = "../lifetimes/lifetime-elision.html"
"ownership/lifetimes.html" = "../lifetimes/lifetime-annotations.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"ownership/moved-strings-rust.html" = "../memory-management/move.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"ownership/move-semantics.html" = "../memory-management/move.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"ownership/moves-function-calls.html" = "../memory-management/move.html"
"ownership/shared-unique-borrows.html" = "../borrowing/shared.html"
"pattern-matching/destructuring-arrays.html" = "../tuples-and-arrays/destructuring.html"
Updated struct and enums in pattern-matching. (#2021) #1464 issue. --------- Co-authored-by: Martin Geisler <martin@geisler.net>
2024-04-30 16:07:10 +02:00
"pattern-matching/destructuring.html" = "destructuring-structs.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"pattern-matching/match-guards.html" = "../tuples-and-arrays/match.html"
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
"running-the-course/day-4.html" = "course-structure.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"sintaxe-bƔsica/funƧƵes-interlude.html" = "../basic-syntax/functions-interlude.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"slices-and-lifetimes/exercise.html" = "../lifetimes/exercise.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"slices-and-lifetimes.html" = "lifetimes.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"slices-and-lifetimes/lifetime-annotations.html" = "../lifetimes/lifetime-annotations.html"
"slices-and-lifetimes/lifetime-elision.html" = "../lifetimes/lifetime-elision.html"
"slices-and-lifetimes/slices.html" = "../references/slices.html"
"slices-and-lifetimes/solution.html" = "../lifetimes/solution.html"
"slices-and-lifetimes/str.html" = "../references/strings.html"
"slices-and-lifetimes/struct-lifetimes.html" = "../lifetimes/struct-lifetimes.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"std/box.html" = "../smart-pointers/box.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"std/box-niche.html" = "../smart-pointers/box.html"
"std/box-recursive.html" = "../smart-pointers/box.html"
"std/cell.html" = "../borrowing/interior-mutability.html"
"std/hashmap.html" = "../std-types/hashmap.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"std.html" = "std-types/std.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"std/option-result.html" = "../std-types/option.html"
"std/rc.html" = "../smart-pointers/rc.html"
"std/string.html" = "../std-types/string.html"
"std/vec.html" = "../std-types/vec.html"
"structs/field-shorthand.html" = "../user-defined-types/named-structs.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"structs.html" = "user-defined-types/named-structs.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"structs/tuple-structs.html" = "../user-defined-types/tuple-structs.html"
Fix page redirects (#620) * Fix broken redirects A few of these were wrong since they assumed the target path is relative to the root of the course (the path is relative to the page being redirected). * Sort redirects
2023-05-08 16:31:54 +02:00
"structure.html" = "running-the-course/course-structure.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"testing/doc-tests.html" = "../testing/other.html"
Move Mockall and GoogleTest slides to Android section (#1533) After #1528 and #1532, we now have actual slides which showcase the crates in action. So we can reclaim a few minutes by removing the slide which mentions Mockall and GoogleTest slide. The slide mentioned [proptest](https://docs.rs/proptest) and [rstest](https://docs.rs/rstest) as well. While I'm sure the libraries are useful, we don't have them imported into AOSP and I've never personally used them. We should therefore not advertise them yet at this point since they won't be useful to Android engineers. Of course we can mention things that are not in AOSP (or in Chromium), but I think we should do it in the speaker notes at most.
2024-03-04 17:25:35 +02:00
"testing/googletest.html" = "../android/testing/googletest.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"testing/integration-tests.html" = "../testing/other.html"
Move Mockall and GoogleTest slides to Android section (#1533) After #1528 and #1532, we now have actual slides which showcase the crates in action. So we can reclaim a few minutes by removing the slide which mentions Mockall and GoogleTest slide. The slide mentioned [proptest](https://docs.rs/proptest) and [rstest](https://docs.rs/rstest) as well. While I'm sure the libraries are useful, we don't have them imported into AOSP and I've never personally used them. We should therefore not advertise them yet at this point since they won't be useful to Android engineers. Of course we can mention things that are not in AOSP (or in Chromium), but I think we should do it in the speaker notes at most.
2024-03-04 17:25:35 +02:00
"testing/mockall.html" = "../android/testing/mockall.html"
"testing/useful-crates.html" = "../testing.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"traits/closures.html" = "../std-traits/closures.html"
"traits/default.html" = "../std-traits/default.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"traits/default-methods.html" = "../methods-and-traits/traits.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"traits/deriving-traits.html" = "../methods-and-traits/deriving.html"
"traits/drop.html" = "../memory-management/drop.html"
"traits/from-into.html" = "../std-traits/from-and-into.html"
"traits/from-iterator.html" = "../iterators/fromiterator.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"traits.html" = "methods-and-traits/traits.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"traits/impl-trait.html" = "../generics/impl-trait.html"
"traits/important-traits.html" = "../std-traits/comparisons.html"
"traits/iterator.html" = "../iterators/iterators.html"
"traits/operators.html" = "../std-traits/operators.html"
"traits/read-write.html" = "../std-traits/read-and-write.html"
"traits/trait-bounds.html" = "../generics/trait-bounds.html"
"traits/trait-objects.html" = "../smart-pointers/trait-objects.html"
Rework introduction of pattern matching (#1843)
2024-02-28 21:14:53 +02:00
"tuples-and-arrays/match.html" = "../pattern-matching/match.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"tuples-and-arrays/tuples-and-arrays.html" = "tuples.html"
Move slices and strings to references section (#1898) This PR moves the slides for slices and strings into the day 1 section on references. This seems like the more natural place to introduce slices since slices are a type of reference. It then also made sense to me to follow that with the introduction of `&str` and `String`, since students now have the context to understand what a "string slice" is. I also removed the strings slide from the types and values section since it didn't make sense to cover the same topic twice in the same day. I tested this new organization in my class on Wednesday and it didn't cause day 1 to take too long.
2024-03-14 22:21:15 +02:00
"types-and-values/strings.html" = "../references/strings.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"unsafe/calling-unsafe-functions.html" = "../unsafe-rust/unsafe-functions.html"
"unsafe/extern-functions.html" = "../unsafe-rust/unsafe-functions.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"unsafe.html" = "unsafe-rust/unsafe.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"unsafe/mutable-static-variables.html" = "../unsafe-rust/mutable-static.html"
Add redirects for all broken links to book.toml (#814) This should clean up the list of 404 errors in the Search Console.
2023-06-14 11:21:22 +02:00
"unsafe/mutable-static-variables.md" = "mutable-static-variables.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"unsafe/raw-pointers.html" = "../unsafe-rust/dereferencing.html"
"unsafe/unions.html" = "../unsafe-rust/unions.html"
Setup redirects after #120 and #177 (#352) This makes `mdbook` output a simple redirect at the location of the old pages. Iā€™ll try to add such pages when we shuffle around our pages to make sure external links stay valid.
2023-02-06 18:10:01 +02:00
"unsafe/unsafe-functions.html" = "calling-unsafe-functions.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"unsafe/unsafe-traits.html" = "../unsafe-rust/unsafe-traits.html"
"unsafe/writing-unsafe-functions.html" = "../unsafe-rust/unsafe-functions.html"
Add redirect for static-and-const (#1923) I missed this in #1881 before clicking "merge".
2024-03-19 15:55:15 +02:00
"user-defined-types/static-and-const.html" = "../user-defined-types/static.html"
Cleanup references to "Day 4" (#603) * Align outline with new spin-off course structure With the new structure, the section on Android is a spin-off course from the main 3-day course on Rust Fundamentals. The Bare-metal and Concurrency days are spin-off courses in the same way. * Explain new course structure * Align Bare-Metal welcome page with other deep dives * Merge Day 4 page into Course Structure page * Remove Day 4 Welcome page This aligns the Concurrency in Rust section with the Bare-Metal Rust deep dive. * Show subsections for Android deep dive This aligns the Rust in Android section with the other deep dives. * Clean up welcome page and README We now cover async Rust and the course is no longer a four day course. * Remove reference to the old Day 4 * Remove Day 4 references from exercises
2023-05-02 08:02:28 +02:00
"welcome-bare-metal.html" = "bare-metal.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"welcome-day-1/what-is-rust.html" = "../hello-world/what-is-rust.html"
Rename `welcome.md` to `index.md` (#1039) When building the book, mdBook will always generate an `index.html` page for first page of the book. This meant that we had the same content available under two different names: - `welcome.html`: this is what the TOC would link to, and - `index.html` or simply `/`: this is what search engines link to Renaming the page and setting up a redirect should fix this confusion. We still donā€™t have a good way of avoiding links to the `index.html` page, but this should fix the first half of the problem. I tested this for translations as well by building the output in a subdirectory and serving the parent directory. Part of #847.
2023-07-28 17:27:31 +02:00
"welcome.html" = "./"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"why-rust/an-example-in-c.html" = "../hello-world/example.html"
"why-rust/compile-time.html" = "../hello-world/benefits.html"
Update Concurrency course with times (#2007) As I mentioned in #1536: * Break into segments at approximately the places @fw-immunant put breaks * Move all of the files into `src/concurrency` * Add timings and segment/session metadata so course outlines appear There's room for more work here, including some additional feedback from @fw-immunant after the session I observed, but let's do one step at a time :)
2024-04-23 15:26:41 +02:00
"why-rust.html" = "hello-world/benefits.html"
Sort `mdbook` redirects (#1761) There were a few comments, but I think itā€™s better to make it all uniform and avoid these comments. The comment was about the v2 rewrite, but this is now done and so the comment is less useful. I also normalized the quotes to double-quotes instead of single-quotes. The latter is a literal string in TOML, but we donā€™t actually have any special characters to escape here.
2024-02-27 19:20:41 +02:00
"why-rust/modern.html" = "../hello-world/benefits.html"
"why-rust/runtime.html" = "../hello-world/benefits.html"
Comprehensive Rust v2 (#1073) I've taken some work by @fw-immunant and others on the new organization of the course and condensed it into a form amenable to a text editor and some computational analysis. You can see the inputs in `course.py` but the interesting bits are the output: `outline.md` and `slides.md`. The idea is to break the course into more, smaller segments with exercises at the ends and breaks in between. So `outline.md` lists the segments, their duration, and sums those durations up per-day. It shows we're about an hour too long right now! There are more details of the segments in `slides.md`, or you can see mostly the same stuff in `course.py`. This now contains all of the content from the v1 course, ensuring both that we've covered everything and that we'll have somewhere to redirect every page. Fixes #1082. Fixes #1465. --------- Co-authored-by: Nicole LeGare <dlegare.1001@gmail.com> Co-authored-by: Martin Geisler <mgeisler@google.com>
2023-11-29 17:39:24 +02:00
Run exerciser as mdbook renderer.
2023-04-03 17:18:32 +02:00
[output.exerciser]
Rename exercise template directory and archive.
2023-04-05 17:15:42 +02:00
output-directory = "comprehensive-rust-exercises"
Fix a broken link and check internal links (#2195) In #2153 I aimed to fix a link but broke it. In this PR, I fix it and add [`mdbook-linkcheck`](https://github.com/Michael-F-Bryan/mdbook-linkcheck) to avoid future cases. Some past fixes that could have been prevented, in addition to mine in this PR: * #811 * #2064 * #2146 Note: `mdbook-linkcheck` may also check external links with a configuration change. It can be beneficial to check also external links from time to time. I ran it here and found 3 broken links. Maintainers - sorry for the lack of a preceding issue. We can discuss it here. Some remaining work is to fix the outdated internal links in the translations, not done here. Let me know what you think about the proposed contribution. This PR completes #1502.
2024-07-22 13:37:19 +02:00
[output.linkcheck]
optional = true
follow-web-links = false # change to true to check web links
exclude = [
"comprehensive-rust.pdf",
"comprehensive-rust-exercises.zip",
# "crates.io", # uncomment when follow-web-links is true
]
Reference in New Issue Copy Permalink