more documantation is always good!

Author: evombau

.github/workflows/Release.yaml

@@ -4,9 +4,9 @@ on:
   push:
     branches:
       - "main"
-      - '!docu/**'
     paths-ignore:
       - "README.md"
+      - 'docu/**'
       - '.github/ISSUE_TEMPLATE/**'
       - '.github/PULL_REQUEST_TEMPLATE.md'
 

.github/workflows/branchPR.yaml

@@ -7,6 +7,7 @@ on:
       - 'docu/**'
     paths-ignore:
       - "README.md"
+      - 'docu/**'
       - '.github/ISSUE_TEMPLATE/**'
       - '.github/PULL_REQUEST_TEMPLATE.md'
 

README.md

@@ -1,37 +1,29 @@
 # Awesome CI
 
-**Description**: This tool makes your workflow easier! With the help of [SemVer](https://semver.org/lang/) and naming conventions, a lot of time can be saved when creating a release.
+**Description**: This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of [SemVer](https://semver.org/). The required version number is created with the correct naming of the branch prefix.
 
 - **Technology stack**: This tool is written in golang
 - **Status**: Alpha, at release the [CHANGELOG](CHANGELOG.md) would be updated.
-- **Requests**: Please feel free to open an question or feature request in the Issue Board.
-
-## Table of Contents
-
-- [Main features]()
-- [Usage](#usage)
-- [Documentation](https://eksrvb.github.io/awesome-ci/)
-- [Known issues](#known-issues)
-- [Getting help](#getting-help)
-- [Open source licensing info](#open-source-licensing-info)
-- [Credits and references](#credits-and-references)
+- **Requests and Issues**: Please feel free to open an question or feature request in the Issue Board.
 
 ## Usage
 
-to use this tool in your ci pipeline, [download](https://github.com/eksrvb/awesome-ci/releases/latest/download/awesome-ci) the most recently published release. How you can integrate this into your respective pipeline can be found in the following document.
+This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
 
+You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/eksrvb/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the [examples section](https://eksrvb.github.io/awesome-ci/docs/examples) of the documentation. If an example is not included, please feel free to inquire about a related [issue](https://github.com/eksrvb/awesome-ci/issues/new/choose).
 
-## Documentation
+If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a [bug report](https://github.com/eksrvb/awesome-ci/issues/new/choose).
 
-[See the manual](https://eksrvb.github.io/awesome-ci/) for setup and usage instructions.
+If you have any questions, you can find a form on the issue board. First, make sure your question is already in the [Questions and Answers](https://eksrvb.github.io/awesome-ci/docs/questions_and_answers) section before asking a question. You can find frequently asked questions there too.
 
-## Known issues
+## Documentation
 
-There are no known Issues yet.
+[See the manual](https://eksrvb.github.io/awesome-ci/) for setup, usage instructions and a lot more. (the documentation is still rising)
 
 ## Getting help
 
 If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
+You can find frequently asked questions directly in the "Questions and Answers" section.
 
 ## Getting involved
 

CONTRIBUTING.md docs/CONTRIBUTING.mdCONTRIBUTING.md renamed to docs/CONTRIBUTING.md

@@ -1,3 +1,9 @@
+---
+layout: default
+title: Contributing
+nav_order: 5
+---
+
 # Contributing
 
 When contributing to this repository, please first discuss the change you wish to make via issue,

docs/index.md

@@ -4,7 +4,15 @@ title: Home
 nav_order: 1
 ---
 
-## Welcome to the awesome-ci documentation!
+## Welcome to the Awesome CI documentation!
+
+This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
+
+You can use this tool in your CI pipeline or locally on your command line. Just download the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the examples section of the documentation. If an example is not included, please feel free to inquire about a related issue.
+
+If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a bug report.
+
+If you have any questions, you can find a form on the issue board. First, make sure your question is already in the Questions and Answers section before asking a question. You can find frequently asked questions directly in the "Questions and Answers" section.
 
 ### Notice:
 

docs/questions_and_answers.md

@@ -0,0 +1,17 @@
+---
+layout: default
+title: Questions and Answers
+nav_order: 4
+---
+
+# Questions and Answers
+
+Frequently asked questions are shown here.
+
+
+## Table of Contents
+
+- nothing
+
+
+tbd