Skip to content

Commit 688f0f4

Browse files
committed
[NFC] GettingStarted: Use new GitHub alert syntax
But only for top-level alerts. Nested alerts will not render. See https://github.com/orgs/community/discussions/16925#discussioncomment-9538837.
1 parent 53f0a7f commit 688f0f4

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ toolchain as a one-off, there are a couple of differences:
9595
cd swift
9696
utils/update-checkout --clone
9797
```
98-
> **Note**
98+
> **Important**\
9999
> If you've already forked the project on GitHub at this stage, **do not
100100
> clone your fork** to start off. We describe [how to setup your fork](#setting-up-your-fork)
101101
> in a subsection below.
@@ -121,7 +121,7 @@ toolchain as a one-off, there are a couple of differences:
121121
Detailed branching information, including names for release branches, can
122122
be found in [Branches.md](/docs/Branches.md).
123123
124-
> **Note**
124+
> [!NOTE]
125125
> The commands used in the rest of this guide assumes that the absolute path
126126
> to your working directory is something like `/path/to/swift-project/swift`.
127127
> Double-check that running `pwd` prints a path ending with `swift`.
@@ -193,7 +193,7 @@ toolchain as a one-off, there are a couple of differences:
193193
sudo chmod +x /usr/local/bin/sccache
194194
```
195195

196-
> **Note**
196+
> [!NOTE]
197197
> LLDB currently requires at least `swig-1.3.40` but will successfully build
198198
> with version 2 shipped with Ubuntu.
199199

@@ -209,7 +209,7 @@ toolchain as a one-off, there are a couple of differences:
209209
* If you installed and want to use Sccache: Run `sccache --version`; check
210210
that this succeeds.
211211

212-
> **Note**
212+
> [!NOTE]
213213
> If you are running on Apple Silicon hardware (M1, M2, etc), ensure you have
214214
> the native arm64 build of these dependencies installed and configured in your PATH.
215215
>
@@ -250,8 +250,9 @@ to understand what the different tools do:
250250
is a high-level automation script that handles configuration (via CMake),
251251
building (via Ninja), caching (via Sccache), running tests and more.
252252
253-
> **Pro Tip**: Most tools support `--help` flags describing the options they
254-
> support. Additionally, both Clang and the Swift compiler have hidden flags
253+
> [!TIP]
254+
> Most tools support `--help` flags describing the options they support.
255+
> Additionally, both Clang and the Swift compiler have hidden flags
255256
> (`clang --help-hidden`/`swiftc --help-hidden`) and frontend flags
256257
> (`clang -cc1 --help`/`swiftc -frontend --help`) and the Swift compiler
257258
> even has hidden frontend flags (`swiftc -frontend --help-hidden`). Sneaky!
@@ -363,7 +364,7 @@ whenever the heading is modified.
363364
This workflow enables you to edit, build, run, and debug in Xcode. The
364365
following steps assume that you have already [built the toolchain with Ninja](#the-actual-build).
365366

366-
> **Note**
367+
> [!NOTE]
367368
> A seamless LLDB debugging experience requires that your `build-script`
368369
invocation for Ninja is tuned to generate build rules for the
369370
[debug variant](#debugging-issues) of the component you intend to debug.

0 commit comments

Comments
 (0)