Updated README about documentation #481

mercedes-benz · Dec 9, 2020 · 3370400 · 3370400
1 parent 4dba50a
commit 3370400
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,15 +1,15 @@
 # About
 
 ## What is this folder for?
-This folder contains the github pages documentation content.
+This folder is used for SecHub [GitHub pages](https://daimler.github.io/sechub/).
+
 
 ## Why is this folder empty?
-We do provide github pages only inside branch `documentation`.
-So for all other branches this ignored by git
+Only branch `documentation` contains data - so for all other branches this ignored by git.
 
 ## How is github pages updated?
-After a release build has been done the HTML documentation artifact content will be copied to
-dedicated docs folder (currently we support only `latest`) in branch `documentation`. 
+After a release build has been done, the HTML documentation artifact content will be copied to a
+dedicated subfolder (currently we support only `latest`) in branch `documentation`. 
 
 After a push it will be available after a short while when jekyll has rebuild pages.