From 08451d98cd6cb0082f00a036a46d5c6f0c65bc37 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Thu, 24 Sep 2015 15:38:26 -0700 Subject: [PATCH] docs: updated some links in index files Signed-off-by: Mihai Tudor Panu --- doxy/README.cpp.md | 20 +++++++++---------- doxy/README.java.md | 20 +++++++++---------- doxy/index.rst | 2 +- .../yuidoc/tmpl/partials/index.handlebars | 2 +- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doxy/README.cpp.md b/doxy/README.cpp.md index dde66671..e778e1e1 100644 --- a/doxy/README.cpp.md +++ b/doxy/README.cpp.md @@ -21,7 +21,7 @@ However implementation and API design is completely up to the developer, some enumerable sensors for example may provide much clever instantiation. Displays may also create more complex structures in order to interface with them. -Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples). +Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/c%2B%2B). Multi-sensor samples for the starter and specialized kits can be found in the [iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. @@ -43,21 +43,21 @@ please follow the instructions provided on the Intel Developer Zone IDE page. ### Building UPM -See @ref building [here](docs/building.md). +See @ref building here. ### Making your own UPM module -@ref porting [link](docs/porting.md) has more information on making new UPM modules. +@ref porting link has more information on making new UPM modules. -There is also an example available for @ref max31855 [sensor](docs/max31855.md). +There is also an example available for @ref max31855 sensor. ### Naming conventions and rules for new UPM contributions -Before you begin development, take a look at our @ref naming [conventions](docs/naming.md). +Before you begin development, take a look at our @ref naming conventions. -Also, please read the guidelines for @ref contributions [to UPM](docs/contributions.md). +Also, please read the guidelines for @ref contributions to UPM. -Don't forget to check the @ref documentation [section](docs/documentation.md). +Don't forget to check the @ref documentation section. Make sure you add yourself as an author on every new code file submitted. If you are providing a fix with significant changes, feel free to add yourself @@ -68,7 +68,7 @@ API Documentation @htmlonly - + @@ -76,7 +76,7 @@ API Documentation @endhtmlonly ### Changelog -Version @ref changelog [here](docs/changelog.md). +Version @ref changelog here. ### Known Limitations -List of @ref knownlimitations [here](docs/knownlimitations.md). +List of @ref knownlimitations here. diff --git a/doxy/README.java.md b/doxy/README.java.md index aa12c2b3..71d5fd1f 100644 --- a/doxy/README.java.md +++ b/doxy/README.java.md @@ -21,7 +21,7 @@ However implementation and API design is completely up to the developer, some enumerable sensors for example may provide much clever instantiation. Displays may also create more complex structures in order to interface with them. -Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples). +Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/examples/java). Multi-sensor samples for the starter and specialized kits can be found in the [iot-devkit-samples](https://github.com/intel-iot-devkit/iot-devkit-samples) repository. @@ -43,21 +43,21 @@ please follow the instructions provided on the Intel Developer Zone IDE page. ### Building UPM -See @ref building [here](docs/building.md). +See @ref building here. ### Making your own UPM module -@ref porting [link](docs/porting.md) has more information on making new UPM modules. +@ref porting link has more information on making new UPM modules. -There is also an example available for @ref max31855 [sensor](docs/max31855.md). +There is also an example available for @ref max31855 sensor. ### Naming conventions and rules for new UPM contributions -Before you begin development, take a look at our @ref naming [conventions](docs/naming.md). +Before you begin development, take a look at our @ref naming conventions. -Also, please read the guidelines for @ref contributions [to UPM](docs/contributions.md). +Also, please read the guidelines for @ref contributions to UPM. -Don't forget to check the @ref documentation [section](docs/documentation.md). +Don't forget to check the @ref documentation section. Make sure you add yourself as an author on every new code file submitted. If you are providing a fix with significant changes, feel free to add yourself @@ -68,7 +68,7 @@ API Documentation @htmlonly - + @@ -76,7 +76,7 @@ API Documentation @endhtmlonly ### Changelog -Version @ref changelog [here](docs/changelog.md). +Version @ref changelog here. ### Known Limitations -List of @ref knownlimitations [here](docs/knownlimitations.md). +List of @ref knownlimitations here. diff --git a/doxy/index.rst b/doxy/index.rst index ed15fe48..50fa8537 100644 --- a/doxy/index.rst +++ b/doxy/index.rst @@ -66,7 +66,7 @@ Don't forget to check the documentation `section -

+