diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..96d1b448e --- /dev/null +++ b/doc/README.md @@ -0,0 +1,16 @@ +# IoT Agent documentation + +## User documentation + +- [Getting started](getting-started.md) +- [IoT Agent API](api.md) +- [Installation and administration manual](admin.md) +- [Deprecated features](deprecated.md) +- [Roadmap](roadmap.md) + +## Development documentation + +- [Development manual](devel/development.md) +- [Contributing guide](devel/contribution-guidelines.md) +- [Architecture](devel/architecture.md) +- [North Port - NGSI Interactions](devel/northboundinteractions.md) diff --git a/doc/admin.md b/doc/admin.md index 8677e47a3..9d5ca99f1 100644 --- a/doc/admin.md +++ b/doc/admin.md @@ -36,7 +36,7 @@ - [Alarms](#alarms) The **IoT Agent node library** is not a standalone product and should be added as a dependency to `package.json` of the -project is going to be used in. The library is published in the NPM repository, so it can be added to the project by +project is going to be used in. The library is published in the npm repository, so it can be added to the project by adding the following line to the `package.json` file: ```json diff --git a/mkdocs.yml b/mkdocs.yml index 94795c5a5..090c06b71 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,15 +13,10 @@ pages: - Home: 'index.md' - 'Getting Started' : 'getting-started.md' - 'User & Programmers Manual': - - 'Architecture' : 'architecture.md' - 'IoT Agent API' : 'api.md' - - 'Advanced Topics' : 'advanced-topics.md' - - 'Library Functions': 'usermanual.md' - - 'Measurement Transformation Expression Language': 'expressionLanguage.md' - - 'How to develop a new IoT Agent': 'howto.md' - - 'North Port - NGSI Interactions': 'northboundinteractions.md' - - 'Development Documentation': development.md - - 'Installation & Administration Manual': - - 'Installation Guide': 'installationguide.md' - - 'Operations (logs & alarms)': 'operations.md' - + - 'Installation and administration manual': 'admin.md' + - 'Development documentation': + - 'Development manual': 'devel/development.md' + - 'Contributing guide': 'devel/contribution-guidelines.md' + - 'Architecture' : 'devel/architecture.md' + - 'North Port - NGSI Interactions': 'devel/northboundinteractions.md' \ No newline at end of file