Merge pull request #235 from romanowski/docs/fix-broken-links

romanowski · web-flow · commit 2834029cc211 · 2021-10-18T21:31:33.000-07:00
Add basics and intro sections
diff --git a/examples/intro/README.md b/examples/intro/README.md
@@ -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)
diff --git a/website/docs/commands/basics.md b/website/docs/commands/basics.md
@@ -1,5 +1,5 @@
 ---
-title: Inputs
+title: Basics
 sidebar_position: 3
 ---
 
diff --git a/website/docs/commands/run.md b/website/docs/commands/run.md
@@ -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
diff --git a/website/docs/commands/test.md b/website/docs/commands/test.md
@@ -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
 
diff --git a/website/docs/cookbooks/intro.md b/website/docs/cookbooks/intro.md
@@ -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)
diff --git a/website/docs/guides/configuration.md b/website/docs/guides/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: Configuration
-sidebar_position: 20
+sidebar_position: 9
 ---
 
 `scala-cli` can be configured in several ways:
diff --git a/website/docs/guides/dependencies.md b/website/docs/guides/dependencies.md
@@ -1,6 +1,6 @@
 ---
 title: Managing dependencies
-sidebar_position: 23
+sidebar_position: 9
 ---
 
 # Dependencies
diff --git a/website/docs/guides/intro.md b/website/docs/guides/intro.md
@@ -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
+`
diff --git a/website/docs/guides/sbt-mill.md b/website/docs/guides/sbt-mill.md
@@ -1,6 +1,6 @@
 ---
 title: SBT and Mill
-sidebar_position: 11
+sidebar_position: 12
 ---
 
 TODO: Explain how export to sbt/mill works
diff --git a/website/docs/guides/using-directives.md b/website/docs/guides/using-directives.md
@@ -1,6 +1,6 @@
 ---
 title: Using directives
-sidebar_position: 24
+sidebar_position: 11
 ---
 
 :::warning
diff --git a/website/docs/overview.md b/website/docs/overview.md
@@ -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
 
@@ -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!**
 
diff --git a/website/docs/scala-ecosystem.md b/website/docs/scala-ecosystem.md
@@ -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
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -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'
         },
         {

Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,4 @@ sidebar_position: 1`
`7`	`7`
`8`	`8`	`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.`
`9`	`9`
`10`		`-For more in-depth analysis please check out provided [Guides](../guides/ide.md)`
	`10`	`+For more in-depth analysis please check out provided [Guides](../guides/intro.md)`