Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/index/README.md → examples/intro/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<!--
File was generated from based on docs/cookbooks/index.md, do not edit manually!
File was generated from based on docs/cookbooks/intro.md, do not edit manually!
-->


# Cookbook

This part contains a set of recipes how to use scala-cli within given situations. The cookbooks are intended to provide a solution to task at hand without providing too many details.

For more in-depth analysis please check out provided [Guides](../guides/ide.md)
For more in-depth analysis please check out provided [Guides](../guides/introduction.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Inputs
title: Basics
sidebar_position: 3
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ We have a dedicated [Scala.js guide](../guides/scala-js.md).
## Scala Native

Scala Native applications can also be compiled and run, with the `--native` option.
Note that the [Scala Native requirements](https://scala-native.readthedocs.io/en/latest/user/setup.html#installing-clang-and-runtime-dependencies) need to be [installed](install#scala-native) for this to work fine,
Note that the [Scala Native requirements](https://scala-native.readthedocs.io/en/latest/user/setup.html#installing-clang-and-runtime-dependencies) need to be [installed](/install#scala-native) for this to work fine,
and that Scala Native only supports Linux and macOS for now.

```bash
Expand Down
2 changes: 1 addition & 1 deletion website/docs/commands/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 7
The `test` command allows to run test suites that come from the test sources.
Test sources are complied separately (after the 'main' sources) and may use different dependencies, compiler options and other configuration.

All command line options applies to the both main and test sources so [using directives](http://localhost:3000/docs/guides/using-directives) (or [special imports](./guides/configuration#special-imports).md) can be used to provide test-specific configuration.
All command line options applies to the both main and test sources so [using directives](http://localhost:3000/docs/guides/using-directives) (or [special imports](../guides/configuration#special-imports).md) can be used to provide test-specific configuration.

## Test sources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ sidebar_position: 1

This part contains a set of recipes how to use scala-cli within given situations. The cookbooks are intended to provide a solution to task at hand without providing too many details.

For more in-depth analysis please check out provided [Guides](../guides/ide.md)
For more in-depth analysis please check out provided [Guides](../guides/intro.md)
2 changes: 1 addition & 1 deletion website/docs/guides/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuration
sidebar_position: 20
sidebar_position: 9
---

`scala-cli` can be configured in several ways:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/dependencies.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing dependencies
sidebar_position: 23
sidebar_position: 9
---

# Dependencies
Expand Down
15 changes: 15 additions & 0 deletions website/docs/guides/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Introduction
sidebar_position: 1
---

This section guides dedicated various aspects of Scala CLI that applies across various commands.

Our guides covers many aspects that sometimes may be quite detailed that is why we recommend starting:
- [Configuration guide](./configuration.md) - to learn how to configure various options and what style of configuration are best for the given use case
- [Ide guide](./ide.md) - how to import and use Scala CLI-based projects in your favorite IDE\
- [Using directives guide](./using-directives.md) - experimental syntax used to store configuration within .scala or .sc files used in Scala CLI
- [Scala.js](./scala-js.md) and [Scala Native](./scala-native.md) guides - to learn how Scala CLI supports other platforms then JVM
- [sbt/mill export](./sbt-mill.md) guide - to learn how to convert your Scala CLI project into sbt or mill (when you need more powerful build tool)
- [Scripting guide](./scripts.md) covers how Scala CLI allows for powerful scripting with Scala
`
2 changes: 1 addition & 1 deletion website/docs/guides/sbt-mill.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SBT and Mill
sidebar_position: 11
sidebar_position: 12
---

TODO: Explain how export to sbt/mill works
2 changes: 1 addition & 1 deletion website/docs/guides/using-directives.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using directives
sidebar_position: 24
sidebar_position: 11
---

:::warning
Expand Down
8 changes: 4 additions & 4 deletions website/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ It can:

Scala CLI supports most recent Scala versions (`3.x`, `2.13.x` and `2.12.x`) and changing the Scala version as easy as providing `--scala` parameter (more in [the cookbook](./cookbooks/scala-versions.md)).

Scala CLI supports as well compiling and running Scala to JVM (by default), [Scala.js](./guides/scala-native.md).
Scala CLI supports as well compiling and running Scala to JVM (by default), [Scala.js](./guides/scala-js.md) and [Scala Native](./guides/scala-native.md).

## Installation

Expand All @@ -30,9 +30,9 @@ Prefer some other way to install Scala CLI? Head out to [Advanced installaion gu
## What next?

Scala-cli documentation is split into 3 main section:
- [Commands](./commands/input.md) where you learn how to use most important commands that Scala CLI offers
- [Guides](./guides/ide.md) where you can read about core aspects of Scala CLI and learn how Scala CLI interacts with other tools like IDE
- Scala CLI [Cookbook](./cookbooks/index.md) where you can learn how to solve particular problems with Scala CLI
- [Commands](./commands/basics.md) where you learn how to use most important commands that Scala CLI offers
- [Guides](./guides/intro.md) where you can read about core aspects of Scala CLI and learn how Scala CLI interacts with other tools like IDE
- Scala CLI [Cookbook](./cookbooks/intro.md) where you can learn how to solve particular problems with Scala CLI

**Happy hackking with Scala CLI!**

Expand Down
2 changes: 1 addition & 1 deletion website/docs/scala-ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 31
:::note
This page is intersted in the future of Scala ecosystem.

If you just want to learn Scala CLI just head out to the [Commands section](./commands/input.md)
If you just want to learn Scala CLI just head out to the [Commands section](./commands/basics.md)
:::

:::warning
Expand Down
6 changes: 3 additions & 3 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ module.exports = {
label: 'Documentation',
},
{
to: '/docs/commands/input',
to: '/docs/commands/basics',
label: 'Commands'
},
{
to: '/docs/guides/ide',
to: '/docs/guides/intro',
label: 'Guides'
},
{
to: '/docs/cookbooks/index',
to: '/docs/cookbooks/intro',
label: 'Cookbook'
},
{
Expand Down