Feat/update-documentation (#705)

* Deven doc update (#699) * updated to 2.1 * deleted files from docs which are in root already * readded yarn lock * yarn-lock * Deven doc update (#699) * updated to 2.1 * deleted files from docs which are in root already * readded yarn lock * yarn-lock * docs: update README.md --------- Signed-off-by: Christian Hoffmann <[email protected]> Co-authored-by: Christian Hoffmann <[email protected]> Co-authored-by: christian.b.hoffmann <[email protected]>
deven-org · Dec 16, 2023 · 3c23ec1 · 3c23ec1
1 parent b0112c8
commit 3c23ec1
Show file tree

Hide file tree

Showing 6 changed files with 167 additions and 3,241 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,10 @@
   - [:star: Introduction](#star-introduction)
     - [Benefits of B01LER](#benefits-of-b01ler)
     - [Common misconceptions](#common-misconceptions)
-      - [1. Web Components are not accessibile](#1-web-components-are-not-accessibile)
+      - [1. Web Components are not accessible](#1-web-components-are-not-accessible)
   - [:art: Resources](#resources)
   - [:tipping_hand_person: Help & Feedback](#help--feedback)
+    - [Discussion Board](#github-discussion-board)
     - [Slack](#slack)
     - [Teams](#teams)
     - [Email](#email)
@@ -30,19 +31,15 @@
 
 
 ## :star: Introduction
-B01LER is a fully customisable design system that enables you to easily create cohesive and consistent digital products 
-across multiple platforms and brands.
+B01LER is a fully customisable design system (DS) that enables you to easily create cohesive and consistent digital products across multiple platforms and brands.
 
-B01LER provides pre-built components that exist in design in the form of a [component library in Figma](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8941%3A1818&mode=design&t=fZvPevNIiIDONPxv-1), as well as in code in a repository (the one you have opened right now), 
-which is also [displayed in the web using Storybook](https://b01ler.onrender.com/). Both the components in design and 
-in code are connected via the token system.
+B01LER provides pre-built components that exist in design in the form of a [component library in Figma](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8941%3A1818&mode=design&t=fZvPevNIiIDONPxv-1), as well as in code in a repository (the one you have opened right now), which is also [displayed in the web using Storybook](https://boilerds.com/storybook). Both the components in design and in code are connected via a token system.
 
-Utilizing design tokens, which represent the visual properties of a design system, such as typography, color and spacing, 
-B01LER is simultaneously consistent and flexible. By changing the tokens, you have the power to change the appearance of 
-the whole design system, including all the components and all the digital products build with it. In design and in code.
+A token system is a collection of values which represent the visual properties of a design system, such as typography, color and spacing.
 
-Overall, B01LER is a powerful tool that helps you work smarter, not harder. By streamlining the design and development 
-processes B01LER empowers you to create better products faster.
+Utilizing tokens, B01LER is simultaneously consistent and flexible. By changing the tokens, you have the power to change the appearance of the whole design, including all the components and all the digital products build with it. In Figma and in code.
+
+Overall, B01LER is a powerful tool that helps you work smarter, not harder. By streamlining the design and development processes B01LER empowers you to create better products faster.
 
 ### Benefits of B01LER
 1. Increased efficiency in building design systems on brand, because semantic structure and architecture are pre-built
@@ -52,8 +49,8 @@ processes B01LER empowers you to create better products faster.
 5. Immense cost savings, because the DS ramp-up phase is reduced from multiple months to days
 
 ### Common misconceptions
-#### 1. Web Components are not accessibile
-Some articles claim, that Web Components are not accessibile or that they are not complying with standard accessibility guidelines. The argument says that assistive technologies like screenreaders can not access the shadow DOM and for example are not able to "see" aria or role attributes that are needed to make components accessible. This is wrong. Modern screenreaders are not "looking" at the DOM. Instead they are accessing the accessibility tree, which is provided by the browser and also contains information from the shadow DOM.
+#### 1. Web Components are not accessible
+Some articles claim, that Web Components are not accessible or that they are not complying with standard accessibility guidelines. The argument says that assistive technologies like screenreaders can not access the shadow DOM and for example are not able to "see" aria or role attributes that are needed to make components accessible. This is wrong. Modern screenreaders are not "looking" at the DOM. Instead they are accessing the accessibility tree, which is provided by the browser and also contains information from the shadow DOM.
 
 
 ## Resources
@@ -62,6 +59,9 @@ Some articles claim, that Web Components are not accessibile or that they are no
 
 
 ## Help & Feedback
+### Github Discussion Board
+Please have a look at our [Github discussion board](https://github.com/deven-org/telemetry-functions/discussions) to raise questions or start a discussion about a future feature.
+
 ### Slack
 Slack is our main internal communications channel and will most likely be the place where you can reach us best. Join the 
 [#boiler](https://song-asg.slack.com/archives/C062PQ9DJTD) channel and say hi 👋 (you need to be part of the Accenture 
@@ -85,21 +85,27 @@ Link to Feedback-Form will be added with [issue #428](https://github.com/deven-o
 
 
 ## Requirements
-First you need to install Git. For more information checkout [Git Documentation](https://git-scm.com/doc).
+First you need to install Git. Git is needed to clone the project to your local machine. If you don't have it installed yet you can follow this [installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
 
 This project is a Node.js package. You need Node Version 18 or higher in order to run it. Check your installed version with node -v. For more information check out the [Node.js Documentation](https://nodejs.org/en/docs/).
 
 If you don't have Yarn installed, please install it (any version, we will pick the right settings later). For more information check out the [Yarn Documentation](https://classic.yarnpkg.com/en/docs). 
 
 In addition, you might need to install Corepack. For more information checkout [Corepack Documentation](https://nodejs.org/api/corepack.html).
 
-
 ## :rocket: How to start
 
 ### Installation
+
 > Note: You need to run terminal as administrator on Windows machines.
 
-1. If you want to use B01LER as a starting point for your own design system, the first step is to fork the repository. This step is only required for the initial setup of you repository.
+1. First, open a terminal and navigate to the folder you want to fork or clone this project
+
+   ```sh
+   $ cd git_projects
+   ```
+
+2. If you want to use B01LER as a starting point for your own design system, the first step is to fork the repository. This step is only required for the initial setup of you repository.
 
    ```sh
    $ gh repo fork REPOSITORY --org "[NAME_OF_YOUR_ORG]"
@@ -111,33 +117,39 @@ In case you want to contribute to this repository, the first step is to clone th
    $ git clone https://github.com/deven-org/B01LER-Kitchen.git
    ```
 
-2. now we enable corepack for yarn and chooose right version
+3. now we enable corepack for yarn and chooose right version
 
    ```sh
    $ corepack enable
    $ yarn set version 4.0.2
    ```
 
-3. Next, install the app
+4. Next, install the app
 
    ```sh
    $ yarn
    ```
 
-4. Now start up your app
+5. Now start up your app
 
    ```sh
    $ yarn start
    ```
 
 ### Setup
+Note: This is not filled out yet!
+
 ...
 
 ### Usage
+Note: This is not filled out yet!
+
 ...
 
 
 ## :white_check_mark: How to test
+Note: This is not filled out yet!
+
 Please provide a short explanation on how and where to run your tests. You can also add a link to the Testing page to
 give further information. Also check out the following example to see one possibility to structure this section.
 

diff --git a/deven-skeleton-install.config.json b/deven-skeleton-install.config.json
@@ -1,3 +1,3 @@
 {
-  "version": "1.5.0"
+  "version": "2.1.0"
 }
diff --git a/doc/CODE_OF_CONDUCT.md b/doc/CODE_OF_CONDUCT.md
diff --git a/doc/README.md b/doc/README.md
diff --git a/package.json b/package.json
@@ -49,6 +49,7 @@
     "@boiler/react-example-app": "0.0.1",
     "@commitlint/cli": "17.4.2",
     "@commitlint/config-conventional": "17.4.2",
+    "@deven-org/documentation-skeleton": "^2.1.0",
     "@open-wc/testing": "3.1.7",
     "@storybook/addon-a11y": "7.4.6",
     "@storybook/addon-actions": "7.4.6",
@@ -70,7 +71,6 @@
     "clean-webpack-plugin": "^4.0.0",
     "copy-webpack-plugin": "^11.0.0",
     "css-loader": "^6.7.3",
-    "deven-documentation-skeleton": "^1.5.0",
     "eslint": "^8.53.0",
     "eslint-webpack-plugin": "^3.2.0",
     "fork-ts-checker-webpack-plugin": "^7.3.0",