Skip to content
This repository was archived by the owner on Feb 26, 2026. It is now read-only.

Commit 652ad7a

Browse files
authored
MG-897 - Remove landing page from documentation (#74)
* remove landing page Signed-off-by: Musilah <nataleigh.nk@gmail.com> * add tailwind Signed-off-by: Musilah <nataleigh.nk@gmail.com> * update the svg images Signed-off-by: Musilah <nataleigh.nk@gmail.com> * fix broken link Signed-off-by: Musilah <nataleigh.nk@gmail.com> * fix api links Signed-off-by: Musilah <nataleigh.nk@gmail.com> * fix SMQ links Signed-off-by: Musilah <nataleigh.nk@gmail.com> --------- Signed-off-by: Musilah <nataleigh.nk@gmail.com>
1 parent 26e67aa commit 652ad7a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+2354
-5332
lines changed

docs/dev-guide/api.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: API
44

55
## Reference
66

7-
API reference in the Swagger UI can be found at: [https://api.magistrala.abstractmachines.fr][api]
7+
The API reference is available at the [Magistrala API documentation site](https://docs.api.magistrala.abstractmachines.fr/)
88

99
## Users
1010

@@ -2643,5 +2643,3 @@ Content-Type: application/json
26432643
Connection: keep-alive
26442644
Access-Control-Expose-Headers: Location
26452645
```
2646-
2647-
[api]: https://absmach.github.io/magistrala

docs/dev-guide/bootstrap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,4 +248,4 @@ For more information about the Bootstrap service API, please check out the [API
248248

249249
> This feature is currently under development :hammer:
250250
251-
[api-docs]: https://github.com/absmach/magistrala/blob/main/api/openapi/bootstrap.yml
251+
[api-docs]: https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=users.yml

docs/dev-guide/certs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,5 +156,5 @@ For more information about the Certification service API, please check out the [
156156

157157
[vault-pki-engine]: https://learn.hashicorp.com/tutorials/vault/pki-engine
158158
[meodor-vault]: https://github.com/mteodor/vault
159-
[api-docs]: https://github.com/absmach/magistrala/blob/main/api/openapi/certs.yml
160-
[magistrala-vault]: https://github.com/absmach/magistrala/blob/main/docker/addons/vault/README.md#setup
159+
[api-docs]: https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=api%2Fcerts.yaml
160+
[magistrala-vault]: https://github.com/absmach/supermq/tree/main/docker/addons/vault

docs/dev-guide/edge.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,7 @@ Agent, on the other hand, returns a response SenML of the following form:
166166

167167
### Remote Commands
168168

169-
EdgeX defines SMA commands in the following [RAML file][edgex-raml]
170-
171-
Commands are:
169+
EdgeX defines SMA commands as
172170

173171
- OPERATION
174172
- CONFIG
@@ -568,7 +566,6 @@ magistrala-mqtt | {"level":"info","message":"Publish - client ID export-88529f
568566
[bootstraping]: ./bootstrap.md#bootstrapping
569567
[provision]: ./provision.md
570568
[edgex-repo]: https://github.com/edgexfoundry/edgex-go
571-
[edgex-raml]: https://github.com/edgexfoundry/edgex-go/blob/master/api/raml/system-agent.raml
572569
[conftoml]: https://github.com/absmach/export/blob/master/configs/config.toml
573570
[docker-compose]: https://github.com/absmach/magistrala/blob/main/docker/docker-compose.yml
574571
[env]: https://github.com/absmach/export#environmet-variables

docs/dev-guide/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2341,5 +2341,5 @@ Example of disconnect event:
23412341
```
23422342

23432343
[redis-streams]: https://redis.io/topics/streams-intro
2344-
[mg-docker-compose]: https://github.com/absmach/magistrala/blob/main/docker/docker-compose.yml
2344+
[mg-docker-compose]: https://github.com/absmach/supermq/blob/main/docker/docker-compose.yaml
23452345
[bootstrap-docker-compose]: https://github.com/absmach/magistrala/blob/main/docker/addons/bootstrap/docker-compose.yml

docs/dev-guide/messaging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ When Unsubscribing from a channel, the reader is closed.
410410
For more information and examples checkout [official nats.io documentation][nats], [official rabbitmq documentation][rabbitmq], [official vernemq documentation][vernemq] and [official kafka documentation][kafka].
411411

412412
[nats-jestream]: https://docs.nats.io/nats-concepts/jetstream
413-
[http-api]: https://github.com/absmach/magistrala/blob/master/api/openapi/http.yml
413+
[http-api]: https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=api%2Fhttp.yaml
414414
[mosquitto]: https://mosquitto.org
415415
[paho]: https://www.eclipse.org/paho/
416416
[rfc7252]: https://tools.ietf.org/html/rfc7252
@@ -421,7 +421,7 @@ For more information and examples checkout [official nats.io documentation][nats
421421
[paho-js]: https://www.eclipse.org/paho/index.php?page=clients/js/index.php
422422
[mqttjs]: https://github.com/mqttjs/MQTT.js
423423
[websocket-client]: http://www.hivemq.com/demos/websocket-client/
424-
[nats]: https://nats.io/documentation/writing_applications/subscribing/
424+
[nats]: https://docs.nats.io/
425425
[rabbitmq]: https://www.rabbitmq.com/documentation.html
426426
[vernemq]: https://docs.vernemq.com/
427427
[kafka]: https://kafka.apache.org/documentation/

docs/dev-guide/opcua.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The OPC-UA adapter can be used in an industrial setup to monitor process values
116116

117117
Clients on magistrala can be created to represent these devices and the channels can be created to represent the data points on the devices. The OPC-UA adapter can then be used to subscribe to the OPC-UA server and forward the data to the NATS message broker. This data can then be consumed by other services in the Magistrala system, and further processing done if need be.
118118

119-
[opcua-adapter]: https://github.com/absmach/magistrala/tree/main/opcua
119+
[opcua-adapter]: https://github.com/absmach/supermq-contrib/tree/main/opcua
120120
[opcua-arch]: https://en.wikipedia.org/wiki/OPC_Unified_Architecture
121121
[public-opcua]: https://github.com/node-opcua/node-opcua/wiki/publicly-available-OPC-UA-Servers-and-Clients
122122
[redis]: https://redis.io/

docs/dev-guide/provision.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ access-control-expose-headers: Location
5252
{"access_token":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mzk0ODU4MDYsImlhdCI6MTczOTQ4MjIwNiwiaXNzIjoic3VwZXJtcS5hdXRoIiwidHlwZSI6MCwidXNlciI6IjBkNDA5NDgyLTA3MzctNDVlYS04Mjg0LTViZDg4MDU5ZjYyNSJ9.nFeihdM7KQJKr_2WQaKUFqBGWVw1qfjh0N6Uc5C6UXc2ugtm4LCf0sjDawi9ok_szk0fQeWWX8bqOsnEvhobZA","refresh_token":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3Mzk1Njg2MDYsImlhdCI6MTczOTQ4MjIwNiwiaXNzIjoic3VwZXJtcS5hdXRoIiwidHlwZSI6MSwidXNlciI6IjBkNDA5NDgyLTA3MzctNDVlYS04Mjg0LTViZDg4MDU5ZjYyNSJ9.DbaMpgVPtL7ER5wlsFmVtC3izKgjB66qsl1beT0qnlcWcfp7NQyvBtT0EW3OyibcqG56SnqO0ye1mzaJLgViqg"}
5353
```
5454

55-
For more information about the Users service API, please check out the [API documentation](https://absmach.github.io/magistrala/?urls.primaryName=users.yml).
55+
For more information about the Users service API, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=api%2Fusers.yaml).
5656

5757
## System Provisioning
5858

@@ -376,7 +376,7 @@ date: Tue, 04 Apr 2023 09:57:53 GMT
376376
access-control-expose-headers: Location
377377
```
378378

379-
For more information about the Clients service API, please check out the [API documentation](https://absmach.github.io/magistrala/?urls.primaryName=clients.yml).
379+
For more information about the Clients service API, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=api%2Fclients.yaml).
380380

381381
## Provision Service
382382

@@ -644,7 +644,7 @@ MG_AGENT_BOOTSTRAP_ID=gateway MG_AGENT_BOOTSTRAP_KEY=external_key MG_AGENT_BOOTS
644644

645645
Agent will retrieve connections parameters and connect to Magistrala cloud.
646646

647-
For more information about the Provision service API, please check out the [API documentation](https://github.com/absmach/magistrala/blob/master/api/provision.yml).
647+
For more information about the Provision service API, please check out this [API documentation](https://github.com/absmach/magistrala/tree/main/provision#readme).
648648

649649
[magistrala]: https://github.com/absmach/magistrala
650650
[bootstrap]: https://github.com/absmach/magistrala/tree/main/bootstrap

docs/diagrams/domain_users.svg

Lines changed: 1 addition & 2 deletions
Loading

docs/diagrams/domain_users_administrator.svg

Lines changed: 1 addition & 2 deletions
Loading

0 commit comments

Comments
 (0)