Skip to content

Commit 7deb2e6

Browse files
authored
Merge pull request #1864 from lwronski/sip-docs-first
Make documentation as the sip-first
2 parents 81f6516 + bd33dd2 commit 7deb2e6

File tree

18 files changed

+82
-28
lines changed

18 files changed

+82
-28
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Miscellaneous",
3-
"position": 27
2+
"label": "Miscellaneous ⚡️",
3+
"position": 29
44
}

website/docs/commands/misc/config.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Config
2+
title: Config ⚡️
33
sidebar_position: 1
44
---
55

6+
:::caution
7+
The Config command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";
714

815
The `config` sub-command makes it possible to get and set various configuration values, used by

website/docs/commands/misc/default-file.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Default File
2+
title: Default File ⚡️
33
sidebar_position: 2
44
---
55

6+
:::caution
7+
The Default File is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
The `default-file` sub-command provides sensible default content for files
714
such as `.gitignore` or for GitHub actions workflows, for Scala CLI projects.
815

website/docs/commands/misc/pgp.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: PGP
2+
title: PGP ⚡️
33
sidebar_position: 18
44
---
55

6+
:::caution
7+
The PGP command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
The `pgp` sub-commands are low-level commands, exposing the PGP capabilities of
714
Scala CLI. These capabilities are used in the `publish` and `publish setup` commands
815
in particular.

website/docs/commands/package.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Package
3-
sidebar_position: 17
2+
title: Package ⚡️
3+
sidebar_position: 27
44
---
55

6+
:::caution
7+
The Package command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
import {ChainedSnippets} from "../../src/components/MarkdownComponents.js";
714

815
The `package` command can package your Scala code in various formats, such as:
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Publishing",
3-
"position": 26
2+
"label": "Publishing ⚡️",
3+
"position": 28
44
}

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Publish Local
2+
title: Publish Local ⚡️
33
sidebar_position: 21
44
---
55

6+
:::caution
7+
The Publish Local command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";
714

815
The `publish local` sub-command publishes a Scala CLI project in the local Ivy2

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Publish Setup
2+
title: Publish Setup ⚡️
33
sidebar_position: 19
44
---
55

6+
:::caution
7+
The Publish Setup command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";
714

815
The `publish setup` sub-command configures your project for publishing to Maven repositories,

website/docs/commands/publishing/publish.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
---
2-
title: Publish
2+
title: Publish ⚡️
33
sidebar_position: 20
44
---
55

6+
:::caution
7+
The Publish command is restricted and requires setting the `--power` option to be used.
8+
You can pass it explicitly or set it globally by running:
9+
10+
scala-cli config power true
11+
:::
12+
613
import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js";
714

815
The `publish` sub-command allows to publish Scala CLI projects to Maven repositories.

website/docs/commands/shebang.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Shebang
3-
sidebar_position: 30
3+
sidebar_position: 26
44
---
55

66
This command is equivalent to `run`, but it changes the way Scala CLI parses options (used to configure the tool) and

0 commit comments

Comments
 (0)