docs: improve navigation between documentation pages, fix brooken links

khatastroffik · Jun 9, 2020 · 37fdb48 · 37fdb48
1 parent 08d6899
commit 37fdb48
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -1,14 +1,14 @@
 # Usage Examples
 
-back to [README][readme]
+back to [main project page][mainpage]
 
-The library implemented in the PoC (see [**src**](src) folder) and deployed as a [NPM package](npmp) can be used in different ways by any/multiple client projects (e.g. the provided sample projects).
+The library implemented in the PoC (see [**src**][src] folder) and deployed as a [NPM package][npmp] can be used in different ways by any/multiple client projects (e.g. the provided sample projects).
 
 ## Installation
 
 ### standard installation
 
-In most of the case, the client project needs to install the [NPM package](npmp) as a dependency.
+In most of the case, the client project needs to install the [NPM package][npmp] as a dependency.
 
 The *one-ts-for-all* should be integrated in the client project to augment its functionality, hence it should be installed as a *productive* dependency, hence:
 ```shell
@@ -35,6 +35,6 @@ goto ['Browser' Sample Project](./browser/README.md)
 ### Usage as Typescript module in a TS application
 
 
-[readme]: ../README.md
+[mainpage]: ../README.md
 [src]: ../src
 [npmp]: https://www.npmjs.com/package/@khatastroffik/one-ts-for-all
diff --git a/examples/browser/README.md b/examples/browser/README.md
@@ -1,5 +1,7 @@
 # Browser Sample Project
 
+back to [Samples list][samples] - back to [main project page][mainpage]
+
 This example demonstrate the usage of the PoC/library as an **EcmaScript Module integrated in a web application**.
 
 ## setup
@@ -87,4 +89,7 @@ import { Car } from '@khatastroffik/one-ts-for-all/';
 ...
 ```
 
-depending of the configuration of your (client) project.
+depending of the configuration of your (client) project.
+
+[mainpage]: ../../README.md
+[samples]: ../README.md
diff --git a/examples/node/README.md b/examples/node/README.md
@@ -1,3 +1,8 @@
 # NodeJS Sample Project
 
-This example should demonstrate the usage of the PoC/library as a CommonJS module integrared in a nodeJS project.
+back to [Samples list][samples] - back to [main project page][mainpage]
+
+This example should demonstrate the usage of the PoC/library as a CommonJS module integrared in a nodeJS project.
+
+[mainpage]: ../../README.md
+[samples]: ../README.md