From 1401ed408434f90a54c001def4839ff03af89c0a Mon Sep 17 00:00:00 2001 From: Bastien Dumont <bdumont@grandlyon.com> Date: Mon, 28 Mar 2022 14:07:05 +0200 Subject: [PATCH 1/2] link to wiki --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 345494d02..0abe32edc 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,14 @@ [](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client) [](https://sonarqube.forge.grandlyon.com/dashboard?id=pamn_client) - - # Pamn This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.1.3. +## Wikis + +Find [here](https://forge.grandlyon.com/web-et-numerique/pamn_plateforme-des-acteurs-de-la-mediation-numerique/pamn_client/-/wikis/home) wikis about usefull informations like installation and gitflow. + ## Development server Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. @@ -35,12 +37,16 @@ Run `npm run e2e` to execute the end-to-end tests via [Protractor](http://www.pr Use conventional commit format. For more info please read this article on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) -## Documentation +## Documentation + A documentation is generated with compodoc in addition of the existing documentation on the wiki. + ```sh npm run doc:serve ``` + You can now visualize it at : `localhost:8080` + ## Further help To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). -- GitLab From aea265e84a876a2bda254ebbf264f6c968bbca3d Mon Sep 17 00:00:00 2001 From: Bastien Dumont <bdumont@grandlyon.com> Date: Mon, 28 Mar 2022 14:07:31 +0200 Subject: [PATCH 2/2] wiki typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0abe32edc..2eed6eaac 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ This project was generated with [Angular CLI](https://github.com/angular/angular ## Wikis -Find [here](https://forge.grandlyon.com/web-et-numerique/pamn_plateforme-des-acteurs-de-la-mediation-numerique/pamn_client/-/wikis/home) wikis about usefull informations like installation and gitflow. +Find [here](https://forge.grandlyon.com/web-et-numerique/pamn_plateforme-des-acteurs-de-la-mediation-numerique/pamn_client/-/wikis/home) wikis about useful informations like installation and gitflow. ## Development server -- GitLab