docs: reorganize docs

d-biehl · d-biehl · commit 5fb0d61a8351 · 2023-08-08T11:26:31.000+02:00
diff --git a/docs/cli/about.md b/docs/cli/about.md
@@ -1,3 +1,3 @@
 # About Commandline Interface
 
-TODO
+TODO - write about the CLI
diff --git a/docs/get_started/configuration.md b/docs/get_started/configuration.md
@@ -0,0 +1,14 @@
+# Configuration
+
+- [ ]  What is a `robot.toml` file
+- [ ]  How to use `robot.toml`
+  - [ ] in vscode
+  - [ ] on command line
+  - [ ] in other editors/CI Pipelines, ...
+- [ ] robot.toml
+  - [ ] RobotCode settings
+  - [ ] RobotFramework Settings
+  - [ ] Profiles
+    - [ ] Define profiles
+    - [ ] override vs expand settings
+    - [ ] Use profiles
diff --git a/docs/get_started/quickstart.md b/docs/get_started/quickstart.md
@@ -0,0 +1,15 @@
+# Quickstart
+
+- [ ] How to setup a robotframework project with RobotCode
+  - [ ] Create Virtual Environment
+    - [ ] install robotframework
+    - install additional tools
+       - robotframework-robocop
+       - robotframework-tidy
+    - create your first suite/test
+    - run your first test
+
+    - configure your robotframework project
+      - default settings in robot.toml
+        - python-path = ["resources", "lib"]
+        - output-dir = "reports"
diff --git a/docs/get_started/troubleshooting.md b/docs/get_started/troubleshooting.md
@@ -0,0 +1,3 @@
+# Troubleshooting
+
+TODO
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Welcome to RobotCode
+# About
 
 
 [![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,15 +1,7 @@
-comming soon ...
-
-```python
-def do_something():
-    pass
-```
+# Installation
 
-```robotframework
-*** Settings ***
-Documentation     A test suite with a single test.
+## Visual Studio Code
+comming soon ...
 
-*** Test Cases ***
-Example
-    Log    Hello, Robot!
-```
+## Python
+comming soon ...
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -120,9 +120,14 @@ extra_css:
   - stylesheets/extra.css
 
 nav:
-  - Home: index.md
-  - Features: features.md
-  - Installation: installation.md
+  - Home:
+    - index.md
+    - features.md
+    - installation.md
+  - Get Started:
+    - get_started/quickstart.md
+    - get_started/configuration.md
+    - get_started/troubleshooting.md
   - CLI:
       - About: cli/about.md
       - Reference: cli/reference.md

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# About Commandline Interface`
`2`	`2`
`3`		`-TODO`
	`3`	`+TODO - write about the CLI`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Welcome to RobotCode`
	`1`	`+# About`
`2`	`2`
`3`	`3`
`4`	`4`	`[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)`