Improved Documentation .

Addressing issue #363
- Added details about the `generated.yaml` file in `Development.md`, specifying that it is built via the DevSecOps-MaturityModel-data repository.
- Moved the procedure for generating `generated.yaml` to the root `README.md`, ensuring clear setup instructions.
- Included npm/yarn commands for building the file.
- Suggested potential reorganization of `README.md` or the creation of an `INSTALL.md` for better documentation clarity.

 This update enhances onboarding clarity and ensures contributors can generate necessary YAML files seamlessly.

Author: caffeine-rohit

Development.md

@@ -9,7 +9,7 @@ This guide walks you through **setting up the project locally**, making contribu
 
 ## **Project Setup**
 
-### Development Server :-
+### Development Server
 
 The DSOMM is based [Angular](https://angular.dev/) and uses npm for package management.
 
@@ -45,20 +45,28 @@ curl https://raw.githubusercontent.com/devsecopsmaturitymodel/DevSecOps-Maturity
 
 - Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
 
-### Code scaffolding :-
+## Code Scaffolding
 
 Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
 
-### Build :-
+## Build
 
 Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-### Running unit tests :-
+## Running Unit Tests
 
 Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-### Coding Style Conventions :-
+## Coding Style Conventions
 
 - We follow the coding style defined by [ESLint](https://eslint.org/).
 - We also use [Prettier](https://prettier.io/docs/en/index.html) as our opinionated code formatter.
-- To validate the schemas of the DSOMM yaml files in the IDE, it is recommended to use the VS Code extension [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). The schemas are stored in /src/assets/YAML/schemas
+- To validate the schemas of the DSOMM yaml files in the IDE, it is recommended to use the VS Code extension [redhat.vscode-yaml](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml). The schemas are stored in `/src/assets/YAML/schemas`
+
+### Running Linter
+
+Run `ng lint` to run the linter from the command line.  
+If you want to lint only a specific component, use:
+
+```bash
+ng lint --lint-file-patterns .\src\app\component\xxxxxx\

README.md

@@ -94,6 +94,29 @@ service docker start
 docker run -d -p 80:8080 wurstbrot/dsomm:latest
 ```
 
+## Generating the `generated.yaml` File
+
+The `generated.yaml` file is dynamically created during the build process. If you don’t see this file after setup, follow these steps to generate it:
+
+**1. Clone the Required Repository:**
+The `generated.yaml` file is built via the DevSecOps-MaturityModel-data repository. Make sure you have cloned and set it up correctly.
+
+**2. Run the Build Command:**
+Navigate to the project directory and run the following command:
+- *Using npm:*
+
+```sh
+npm run build
+````
+
+- *Using yarn:*
+
+```sh
+yarn build
+```
+
+*If the file is missing, ensure all dependencies are installed and that you have the correct access to the `DevSecOps-MaturityModel-data` repository.*
+
 ## Activity Definitions
 The definition of the activities are in the [data-repository](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data). 
 

src/assets/YAML/generated/README.md

@@ -8,19 +8,4 @@ It stores configuration settings and other automatically generated data used by
 - It is a machine-generated file that is **not meant to be manually edited**.
 - It helps in **storing configuration settings**, which are loaded at runtime.
 - Used by the application to dynamically configure settings.
-
-## **How is it Generated?**
-
-The `generated.yaml` file is created as part of the DevSecOps Maturity Model’s **build process**. If you don’t see this file after setup, make sure to run:  
-
-```sh
-npm run build
-```
-
-or
-
-```sh
-yarn build
-```
-
-This will generate the required **YAML** file.
+- This file is generated via the [DevSecOps-MaturityModel-data](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data) repository.