Skip to content

Commit e4cfd02

Browse files
authored
Merge pull request #1777 from xerial/patch-1
Fix a broken link
2 parents 66ea06b + 6b7e152 commit e4cfd02

File tree

13 files changed

+32
-32
lines changed

13 files changed

+32
-32
lines changed

website/docs/commands/basics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66
import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
77

88
Scala CLI is a command line tool that executes a given sub-command on the inputs it’s provided with, using a
9-
given [configuration](../guides/configuration.md) to produce a result.
9+
given [configuration](/docs/guides/configuration.md) to produce a result.
1010

1111
The most important sub-commands are:
1212

@@ -44,11 +44,11 @@ Note that all of these input formats can be used alongside each other.
4444
Scala CLI accepts the following types of source code:
4545

4646
- `.scala` files, containing Scala code
47-
- `.sc` files, containing Scala scripts (see more in the [Scripts guide](../guides/scripts.md))
47+
- `.sc` files, containing Scala scripts (see more in the [Scripts guide](/docs/guides/scripts.md))
4848
- `.java` files, containing Java code
49-
- `.md` files, containing Markdown code (experimental, see more in the [Markdown guide](../guides/markdown.md))
49+
- `.md` files, containing Markdown code (experimental, see more in the [Markdown guide](/docs/guides/markdown.md))
5050
- `.c` and `.h` files, containing C code (only as resources for Scala Native, see more in
51-
the [Scala Native guide](../guides/scala-native.md))
51+
the [Scala Native guide](/docs/guides/scala-native.md))
5252
- `.jar` files, (see more in the [Run docs](run#jar))
5353

5454
The following example shows the simplest input format.
@@ -203,7 +203,7 @@ Hello
203203

204204
</ChainedSnippets>
205205

206-
More details in the [GitHub gists cookbook](../cookbooks/gists.md).
206+
More details in the [GitHub gists cookbook](/docs/cookbooks/gists.md).
207207

208208
### Zip archive
209209

@@ -304,7 +304,7 @@ You can also pipe code to `scala-cli` for execution:
304304

305305
</ChainedSnippets>
306306

307-
More details in the [Piping guide](../guides/piping.md).
307+
More details in the [Piping guide](/docs/guides/piping.md).
308308

309309
## Scala CLI version
310310

website/docs/commands/compile.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `compile` command is useful if you want to check that your code compiles
2424

2525
The most common `compile` options are shown below.
2626
For a full list of options, run `scala-cli compile --help`, or check the options linked in the
27-
[reference documentation](../reference/commands.md#compile).
27+
[reference documentation](/docs/reference/commands.md#compile).
2828

2929
## Test scope
3030

@@ -67,7 +67,7 @@ Watching sources, press Ctrl+C to exit.
6767
## Scala version
6868

6969
Scala CLI uses the latest stable version of Scala which was tested in `scala-cli` (see our list
70-
of [Supported Scala Versions](../reference/scala-versions)). You can specify the Scala version you'd like to use
70+
of [Supported Scala Versions](/docs/reference/scala-versions)). You can specify the Scala version you'd like to use
7171
with `--scala`:
7272

7373
```bash
@@ -115,7 +115,7 @@ For compiling with a specific nightly build you have the full version:
115115
scala-cli Hello.scala -S 2.13.9-bin-4505094
116116
```
117117

118-
For setting this inside scala files, use [`using` directives](../guides/using-directives.md):
118+
For setting this inside scala files, use [`using` directives](/docs/guides/using-directives.md):
119119

120120
```scala compile
121121
//> using scala "2.nightly"
@@ -139,15 +139,15 @@ scala-cli compile Hello.scala \
139139
```
140140

141141
Note that `--dependency` is only meant as a convenience. You should favor
142-
adding dependencies in the source files themselves via [`using` directives](../guides/configuration.md#special-imports).
142+
adding dependencies in the source files themselves via [`using` directives](/docs/guides/configuration.md#special-imports).
143143

144144
You can also add simple JAR files — those that don’t have transitive dependencies — as dependencies, with `--jar`:
145145

146146
```bash
147147
scala-cli compile Hello.scala --jar /path/to/library.jar
148148
```
149149

150-
See the [Dependency management](../guides/dependencies.md) guide for more details.
150+
See the [Dependency management](/docs/guides/dependencies.md) guide for more details.
151151

152152
## Scala compiler options
153153

website/docs/commands/publishing/publish-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ In particular, one can configure:
2929
- Sonatype credentials (to upload artifacts to Maven Central)
3030
- a GitHub token (to upload repository secrets to GitHub, and artifacts to Maven repositories of GitHub Packages)
3131

32-
User-wide configuration in Scala CLI is handled by the [`config` command](../misc/config.md), and
32+
User-wide configuration in Scala CLI is handled by the [`config` command](/docs/commands/misc/config.md), and
3333
the sections below show how to use it to configure things for `publish setup`.
3434

3535
### User details
@@ -75,7 +75,7 @@ SONATYPE_USER=me SONATYPE_PASSWORD=1234 scala-cli config publish.credentials s01
7575
```
7676

7777
Note that both user and password arguments are assumed to be secrets, and
78-
accept the format documented [here](../../reference/password-options.md). Beyond environment
78+
accept the format documented [here](/docs/reference/password-options.md). Beyond environment
7979
variables, commands or paths to files can provide those values. They can also be passed
8080
as is on the command line, although this is not recommended for security reasons.
8181

website/docs/commands/run.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ It is also possible to achieve it using `--platform` option:
229229
scala-cli Hello.scala --platform js
230230
```
231231

232-
See our dedicated [Scala.js guide](../guides/scala-js.md) for more information.
232+
See our dedicated [Scala.js guide](/docs/guides/scala-js.md) for more information.
233233

234234
## Scala Native
235235

@@ -246,7 +246,7 @@ It is also possible to achieve it using `--platform` option:
246246
scala-cli Hello.scala --platform native
247247
```
248248

249-
We have a dedicated [Scala Native guide](../guides/scala-native.md) as well.
249+
We have a dedicated [Scala Native guide](/docs/guides/scala-native.md) as well.
250250

251251
## Platform
252252

@@ -279,7 +279,7 @@ Hello world from scala script
279279

280280
</ChainedSnippets>
281281

282-
Our [scripts guide](../guides/scripts.md) provides many more details.
282+
Our [scripts guide](/docs/guides/scripts.md) provides many more details.
283283

284284
## Scala CLI from docker
285285

website/docs/commands/shebang.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ the input, while everything after the input is considered a program argument.
2020
scala-cli shebang [scala_cli_options]... input [program_arguments]...
2121
```
2222

23-
More details can be found in [Shebang guide](../guides/shebang).
23+
More details can be found in [Shebang guide](/docs/guides/shebang).
2424

website/docs/commands/test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
88
The `test` command runs test suites in the test sources.
99
Test sources are compiled separately (after the 'main' sources), and may use different dependencies, compiler options, and other configurations.
1010

11-
By default, all command line options apply to both the main and test sources, so [using directives](/docs/guides/using-directives.md) (or [special imports](../guides/configuration#special-imports)) can be used to provide test-specific configurations.
11+
By default, all command line options apply to both the main and test sources, so [using directives](/docs/guides/using-directives.md) (or [special imports](/docs/guides/configuration#special-imports)) can be used to provide test-specific configurations.
1212

1313
## Test sources
1414

website/docs/cookbooks/gists.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,4 +116,4 @@ Hello
116116

117117
</ChainedSnippets>
118118

119-
You can find more information on working with Markdown in the [Markdown guide](../guides/markdown.md).
119+
You can find more information on working with Markdown in the [Markdown guide](/docs/guides/markdown.md).

website/docs/cookbooks/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ sidebar_position: 1
88
This section of the documentation contains a set of recipes that show how to use `scala-cli` in certain situations.
99
The recipes are intended to provide a solution to the task at hand, but also without going into great detail.
1010

11-
For more in-depth analysis, please check out our [Guides](../guides/intro.md)
11+
For more in-depth analysis, please check out our [Guides](/docs/guides/intro.md)

website/docs/cookbooks/scala-versions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Picking the Scala version with scala-cli
33
sidebar_position: 2
44
---
55

6-
By default, `scala-cli` runs the latest supported scala version by Scala CLI. See our list of [Supported Scala Versions](../reference/scala-versions) in Scala CLI.
6+
By default, `scala-cli` runs the latest supported scala version by Scala CLI. See our list of [Supported Scala Versions](/docs/reference/scala-versions) in Scala CLI.
77

88
To demonstrate how this works, here’s a universal piece of code that detects the Scala version at runtime.
99
The code is a bit complicated, so we suggest that you skip reading the whole file, and just focus on what it prints:
@@ -121,7 +121,7 @@ Scala: 2\.13\.10
121121
-->
122122

123123
:::note
124-
See our [Using Directives Guide](../guides/using-directives.md) for more details on `using` directives.
124+
See our [Using Directives Guide](/docs/guides/using-directives.md) for more details on `using` directives.
125125
:::
126126

127127

website/docs/guides/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ test
5555

5656
</ChainedSnippets>
5757

58-
The reference documentation lists [all of the available options](../reference/cli-options.md).
58+
The reference documentation lists [all of the available options](/docs/reference/cli-options.md).
5959

6060

6161
## In .scala and .sc files
@@ -75,7 +75,7 @@ This is achieved by specifying `using` directives inside comments at the top of
7575
// package and import statements follow here ...
7676
```
7777

78-
The reference documentation lists [all available using directives](../reference/directives.md#using-directives).
78+
The reference documentation lists [all available using directives](/docs/reference/directives.md#using-directives).
7979

8080
### Special imports
8181

0 commit comments

Comments
 (0)