30 Commits

Author SHA1 Message Date
rami3l
d8ff0014d1 docs(dev-guide): update release process with new backporting flow 2026-04-16 19:13:19 +00:00
Dirkjan Ochtman
6f8931c636 ci: don't install protoc 2026-03-25 09:22:50 +00:00
Eric Huss
665bb6d254 Update to mdbook 0.5 2026-03-25 08:48:01 +00:00
rami3l
d243d7d4ed docs(dev-guide/release-process): mention the CfT blog post 2026-03-04 20:52:25 +00:00
rami3l
06f4eacdaa docs(dev-guide): mention snapshot updating in release process 2025-12-14 10:30:56 +00:00
Eric Huss
933160346f Prepare for mdbook 0.5 migration
Because the pull_request checks are building docs from main, the checks
fail due to mdbook 0.5 changing and removing some fields. This change
should allow the books to work with both 0.4 and 0.5. In particular:

- `multilingual` -- This was never used, is optional, and is ignored in
  0.4. This is rejected in 0.5.
- `curly-quotes` -- This was renamed to `smart-punctuation` a long while
  ago. Both 0.4 and 0.5 use `smart-punctuation`, and 0.5 has removed the
  old `curly-quotes`.
- `src` -- This isn't needed and is an artifact of an `mdbook init` bug.
2025-11-21 21:09:37 +00:00
Jakub Beránek
01977e8bc6 Move the default branch from master to main 2025-10-03 08:27:38 +00:00
rami3l
8b3aedcc59 docs(dev-guide): improve suggestion for overriding arg0 2025-09-12 06:31:32 +00:00
rami3l
e2cfa45dcf docs(dev-guide): mention the arg0 override trick on welcome page 2025-09-12 06:31:32 +00:00
rami3l
664dd00557 docs: replace Discord links 2025-06-27 15:16:06 +00:00
rami3l
2e7c2a98b7 docs(dev-guide): update the section on clippy lints 2025-06-07 15:29:56 +00:00
rami3l
eca06da81f docs(dev-guide): mention test helpers and Assert 2025-06-07 15:29:56 +00:00
rami3l
01d2b65d75 docs(dev-guide/tracing): make "Adding instrumentation" a level-2 title 2024-12-14 07:53:49 +00:00
rami3l
2be04c57ee docs(dev-guide): remove descriptions of rustup_macros 2024-07-31 10:47:49 +00:00
rami3l
c63c3e9025 docs(dev-guide): update description of rustup::process 2024-07-31 10:47:49 +00:00
Josh Hsieh
03b7c56bf0 docs(dev-guide): add guideline for atomic commits to the developer guide
docs(dev-guide): put atomic commits at the beginning
2024-07-30 06:50:07 +00:00
Dirkjan Ochtman
d5a94547cb Rename currentprocess to process
Co-authored-by: rami3l <rami3l@outlook.com>
2024-07-12 01:26:06 +00:00
rami3l
79ba44c281 feat(log): set level of #[tracing::instrument(err)] to TRACE 2024-07-10 10:09:42 +00:00
rami3l
18bf8ba30c feat(log): unhide tracing::instrument from behind feature = "otel" 2024-07-10 10:09:42 +00:00
rami3l
6eb71e956e docs(dev-guide/tracing): mention RUSTUP_LOG and console-based tracing 2024-06-22 12:44:22 +00:00
rami3l
97c64ccb8e docs(dev-guide/linting): improve wording 2024-06-22 12:44:22 +00:00
rami3l
6d160ebdfe docs(dev-guide): remove “pushing to master” in the release process 2024-05-06 12:56:05 +00:00
rami3l
bcccd3ec51 docs(dev-guide): move all mentions of cargo clippy to linting.md 2024-04-09 09:06:43 +00:00
rami3l
52ad0b091a docs(dev-guide): mention that we need to keep mdBook links stable 2024-04-09 09:06:43 +00:00
vchapuis
778b7240a2 doc(dev-guide): Fix test Lint and add explanation
Apply suggestions from code review

Co-authored-by: rami3l <rami3l@outlook.com>

Apply suggestion from code review

Co-authored-by: rami3l <rami3l@outlook.com>

Update doc/dev-guide/src/linting.md

Co-authored-by: rami3l <rami3l@outlook.com>

Removing beta and adding consistency
2024-03-21 23:20:07 +00:00
rami3l
a7c0c45b2d docs(dev-guide): update release-process.md to match the new workflow based on GitHub Merge Queue 2024-03-15 10:17:52 +00:00
Eric Huss
a5b3474481 Update mdbook and fix some source issues. 2024-02-11 01:57:03 +00:00
Sandesh Pyakurel
1241a2f3ba Typo fixed in tips-and-tricks.md file 2023-10-14 18:06:56 +08:00
cui fliter
794e5968c4 Fix some typos
Signed-off-by: cui fliter <imcusg@gmail.com>
2023-10-05 13:17:38 +08:00
Robert Collins
04b72ff07d Migrate CONTRIBUTING.md to an mdbook
We had a suggestion that the dev docs would be easier to read if there
was a table of contents. Rather than making one by hand I thought using
mdbook would be better.
2023-08-13 20:43:08 +02:00