docs: move quick-start to common docs

w4bremer · w4bremer · commit 9ad077dbb8ff · 2024-10-01T20:40:43.000+02:00
diff --git a/docs/docs/features/features.md b/docs/docs/features/features.md
@@ -20,7 +20,7 @@ Basic c++ knowledge is necessary.
 
 ### Code generation
 
-Follow the documentation for the [code generation](/docs/start/first_steps) in general and [CLI](/docs/cli/generate) or the [Studio](/docs/studio/intro) tools.
+Follow the documentation for the [code generation](/docs/guide/intro) in general and [CLI](/docs/cli/generate) or the [Studio](/docs/studio/intro) tools.
 Or try first the [quick start guide](../quickstart/index.md) which shows how to prepare api and generate code out of it.
 
 :::tip
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Template C++ 14
 
-This is the documentation for the _cpp14_ template for the [ApiGear](/docs/start/first_steps) code generator.
+This is the documentation for the _cpp14_ template for the [ApiGear](/docs/guide/intro) code generator.
 
 It is split in several parts:
 
diff --git a/docs/docs/quickstart/index.md b/docs/docs/quickstart/index.md
@@ -1,142 +1,25 @@
 ---
 sidebar_position: 2
 ---
+import QuickStartCommon from "@site/docs/_quickstart_common.md"
 
 # Quick-Start
 
 The Quick-Start guide explains how in a few steps you get from an API definition to a functional c++ example.
 
 Steps one and two are universal for other technologies. In the step two you will choose a concrete _cpp14_ template.
-For more general information about first steps with ApiGear [First Steps](/docs/start/first_steps)
+For more general information about first steps with ApiGear [First Steps](/docs/guide/intro)
 
 The quick start enables only basic features: the [api](features/api.md) generation and simple [stub](features/stubs.md) implementation.
 For all available features check the [overview](features/features.md).
 
-## 1. Install the code generator
+<QuickStartCommon />
 
-Get the [ApiGear Studio](https://github.com/apigear-io/studio/releases) or [ApiGear CLI](https://github.com/apigear-io/cli/releases). For more information check the [ApiGear documentation](/docs/start/install).
+## 5. Use the generated cpp project
 
-## 2. Get the template
+### Project folder structure
 
-There are several options to get the template. Installation via the _Studio_ or the _CLI_. Alternatively it is possible to clone or download from github.
-
-### Installation via CLI
-
-When using the _CLI_ only the highlighted line is imported. You can always check whether the installation was successful via the `template list` command.
-
-```bash
-$ apigear template list
-list of templates from registry and cache
-name                       | installed | registry | url
-apigear-io/template-cpp14 | false     | true     | https://github.com/apigear-io/template-cpp14.git
-...
-# highlight-next-line
-$ apigear template install apigear-io/template-cpp14
-$ apigear template list
-list of templates from registry and cache
-name                       | installed | registry | url
-apigear-io/template-cpp14 | true      | true     | https://github.com/apigear-io/template-cpp14.git
-...
-```
-
-### Installation via Studio
-
-From within the studio the installation is really simple.
-
-1. Open an existing project or create an new one
-2. Go to the `Templates` tab
-3. Click `Install` on the `apigear-io/template-cpp14` entry
-
-### Clone from github
-
-In case you want to check or modify the source code of the template, it is easier to clone or download the repository. The repository does not need to be part of the project, but can be stored anywhere on the computer.
-
-```bash
-$ git clone https://github.com/apigear-io/template-cpp14.git
-```
-
-You can then point the solution file to use your template from its directory by providing relative path from the solution file.
-
-## 3. Set up project
-
-For a project we usually need two files. The solution which specifies what `APIs` and which template to use for it. And at least one `API` module file.
-Both should ideally be in a folder called `apigear` next to each other.
-
-Alternatively, you can also use the _Studio_ to create a new project and modify the two example files.
-
-### Solution file
-
-Create a [solution](/docs/start/first_steps#create-a-solution) file.
-The example below specifies
-
-- module files in _line 8_, here the `helloworld.module.yaml` module with `Hello` API
-- the output directory for generated files in _line 9_
-- a template used to generate the code in _line 10_, here the `apigear-ui/template-cpp14` template. This can also be a path to a local copy of the template.
-- the enabled features of the template in _line 13_, here the `stubs` feature, a simple implementation of interfaces. For all available features check the [overview](features/features.md).
-
-```yaml title="helloworld.solution.yaml" showLineNumbers
-schema: "apigear.solution/1.0"
-name: hello_world_example
-version: "0.1.0"
-
-targets:
-  - name: cpp_hello_world
-    inputs:
-      - helloworld.module.yaml
-    output: ../cpp_hello_world
-    template: apigear-io/template-cpp14
-    force: true
-    features:
-      - stubs
-```
-
-:::tip Targets
-You can extend this solution file with other targets, each for the different technology with different template. The `module.yaml` is technology independent and may be used for any template.
-:::
-
-:::note
-Set the force parameter to true if you want to always override all the generated files. With option set to false some files, like implementation (stub feature) won't be updated. All the API files are always updated.
-:::
-
-### API module file
-
-Use your favorite text editor to create the `helloworld.module.yaml` with the example content:
-
-```yaml title="helloworld.module.yaml" showLineNumbers
-schema: apigear.module/1.0
-name: io.world
-version: "1.0.0"
-
-interfaces:
-  - name: Hello
-    properties:
-      - { name: last, type: Message }
-    operations:
-      - name: say
-        params:
-          - { name: msg, type: Message }
-          - { name: when, type: When }
-        return:
-          type: int
-    signals:
-      - name: justSaid
-        params:
-          - { name: msg, type: Message }
-enums:
-  - name: When
-    members:
-      - { name: Now, value: 0 }
-      - { name: Soon, value: 1 }
-      - { name: Never, value: 2 }
-structs:
-  - name: Message
-    fields:
-      - { name: content, type: string }
-```
-
-## 4. Generate code
-
-With the output directory set as in example, both _ApiGear_ files reside in an `apigear` subfolder next to the _cpp_ generated files.
+With the output directory set as in the example, both _ApiGear_ files reside in an `apigear` subfolder next to the _cpp_ generated files.
 In this case the folder structure should look similar to this
 
 ```bash
@@ -161,26 +44,6 @@ Using the solution file from the previous paragraph the code will be generated i
 With subfolder for each module, here `io_world` as the name of module (defined in line 2 of `helloworld.module.yaml`).
 It contains both features generated: a basic api and a stub implementation.
 
-### Generate via CLI
-
-The following snippet shows how the CLI can be run.
-
-```bash
-$ apigear generate solution apigear/helloworld.solution.yaml
-10:52:20 INF generated 21 files in 30ms. (20 write, 0 skip, 1 copy) topic=gen
-```
-
-- `generate` tells the CLI that it should generate code
-- `solution` specifies that we want to run a solution file
-
-### Generate via Studio
-
-1. Open the project
-2. Go to the `Solutions` tab
-3. Click `Run` on the `helloworld.solution.yaml` entry
-
-## 5. Use the generated cpp project.
-
 The generated code provides cpp _C++_ implementations. The following paragraphs show how you can use it.
 You can start your project loading the top level CMakeLists.txt in `cpp_hello_world` folder.
 
