From 56c2315a1f94c4c4e28599523051870a009f5e13 Mon Sep 17 00:00:00 2001 From: August Andersen Date: Mon, 16 Sep 2024 11:50:08 +0200 Subject: [PATCH] docs upgrade based on angular upgrade and prettified code. --- source/maintenance-guide/maintenance-guide.rst | 2 +- source/programming-guidelines/programming-guidelines.rst | 4 ++-- .../user-interface-guidelines/user-interface-guidelines.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/maintenance-guide/maintenance-guide.rst b/source/maintenance-guide/maintenance-guide.rst index df657f2..2edd419 100644 --- a/source/maintenance-guide/maintenance-guide.rst +++ b/source/maintenance-guide/maintenance-guide.rst @@ -77,7 +77,7 @@ To setup your dev environment please follow these instructions: 1. Get the solution from Github. Clone the OS2IoT-docker, OS2IoT-backend, and OS2IoT-frontend. 2. Install typescript and angular globally on your computer. - a. Angular 9 – install by open terminal and type :code:`npm install -g @angular/cli` + a. Angular 17 – install by open terminal and type :code:`npm install -g @angular/cli@17` b. Typescript – install by open terminal and type :code:`npm install -g typescript` 3. For OS2IoT-frontend install dependencies and start a. Navigate terminal to the OS2IoT-frontend folder and type :code:`npm install` diff --git a/source/programming-guidelines/programming-guidelines.rst b/source/programming-guidelines/programming-guidelines.rst index e9bd0e5..a1cf981 100644 --- a/source/programming-guidelines/programming-guidelines.rst +++ b/source/programming-guidelines/programming-guidelines.rst @@ -27,9 +27,9 @@ Form and style - Each logical component is in its own file. -- Indentation is 4 spaces +- Indentation is 2 spaces -- Lines should be broken if they exceed 160 characters +- Lines should be broken if they exceed 120 characters - Only have one declaration pr. Line diff --git a/source/user-interface-guidelines/user-interface-guidelines.rst b/source/user-interface-guidelines/user-interface-guidelines.rst index da62773..ddb4d45 100644 --- a/source/user-interface-guidelines/user-interface-guidelines.rst +++ b/source/user-interface-guidelines/user-interface-guidelines.rst @@ -366,7 +366,7 @@ JavaScript In accordance with the Angular best practices TypeScript is used and compiled to JavaScript. As of the date of writing this document the -newest version of Angular (9.1) uses TypeScript 3.8. This supports the +used version of Angular (17) uses TypeScript 5. This supports the newest browsers in accordance with the agreement with the customer and thus this is used.