Merge pull request #613 from kikeelectronico/update_docs

Update docs
kikeelectronico · Feb 24, 2024 · f1cc4f9 · f1cc4f9
2 parents c1a6936 + e7d9660
commit f1cc4f9
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/back/homewareAPI.py b/back/homewareAPI.py
@@ -19,17 +19,17 @@
 FOUR_O_ONE = {
     'error': 'Bad authentication',
     'code': 401,
-    'note': 'See the documentation https://kikeelectronico.github.io/Homeware-LAN/api-docs.html'
+    'note': 'See the documentation https://homeware.enriquegomez.me/api-docs.html'
 }
 FOUR_O_FOUR = {
     'error': 'Not found',
     'code': 404,
-    'note': 'See the documentation https://kikeelectronico.github.io/Homeware-LAN/api-docs.html'
+    'note': 'See the documentation https://homeware.enriquegomez.me/api-docs.html'
 }
 FOUR_O_O = {
     'error': 'Operation not supported',
     'code': 400,
-    'note': 'See the documentation https://kikeelectronico.github.io/Homeware-LAN/api-docs.html'
+    'note': 'See the documentation https://homeware.enriquegomez.me/api-docs.html'
 }
 TWO_O_O = {
     'status': 'Success',
@@ -385,7 +385,7 @@ def apiTasksGet(value=''):
             responseData = {
                 'error': 'Invalid task ID, it must be a integer',
                 'code': 400,
-                'note': 'See the documentation https://kikeelectronico.github.io/Homeware-LAN/api/'
+                'note': 'See the documentation https://homeware.enriquegomez.me/api/'
             }
             response = app.response_class(
                 response=json.dumps(responseData),

diff --git a/docs/docs/connect-with-google.md b/docs/docs/connect-with-google.md
@@ -18,22 +18,22 @@ Go to <a href="https://console.actions.google.com/" target="blanck">Actions on G
 1. Select `New project`.
 2. Write a name for the project.
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C1.png"/>
+<img src="/img/connect-with-google/S2C1.png"/>
 
 3. Select `Smart Home` and then click `Start Building`.
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C2.png"/>
+<img src="/img/connect-with-google/S2C2.png"/>
 
 4. Go to `Develop` from the top menu, select `Invocation` in the left side menu, write `Home` as *Display Name* and click `Save`.
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C3.png"/>
+<img src="/img/connect-with-google/S2C3.png"/>
 
 5. Select `Actions` in the left side menu, add the *Fulfillment URL* using your domain and click `Save`
 
 > - Fulfillment URL: `https://<your.domain.com>/smarthome/`
 
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C4.png"/>
+<img src="/img/connect-with-google/S2C4.png"/>
 
 6. Go to `Account Linking` in the left side menu. Enter the client information that the Homeware assistant gives you and click `Next`.
 
@@ -42,15 +42,15 @@ Go to <a href="https://console.actions.google.com/" target="blanck">Actions on G
 - Authorization URL: `https://<your.domain.com>/auth/`
 - Token URL: `https://<your.domain.com>/token/`
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C5.png"/>
+<img src="/img/connect-with-google/S2C5.png"/>
 
 7. Skip this step by clicking `Next`.
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C6.png"/>
+<img src="/img/connect-with-google/S2C6.png"/>
 
 8. Enable *Google to transmit clientID and secret via HTTP basic auth header*, click `Next` and the click `Save`.
 
-<img src="/Homeware-LAN/img/connect-with-google/S2C7.png"/>
+<img src="/img/connect-with-google/S2C7.png"/>
 
 ## Link your Account
 

diff --git a/docs/docs/create-device.md b/docs/docs/create-device.md
@@ -6,7 +6,7 @@ sidebar_label: Create a device
 
 For create a device click `New`.
 
-<img src="/Homeware-LAN/img/create-device/C1.png"/>
+<img src="/img/create-device/C1.png"/>
 
 ## Global Settings
 
@@ -30,11 +30,11 @@ For enabling a trait, click on its switch.
 
 Some traits must be configured, for example in the *Power control* trait we can enable *commandOnlyOnOff* and *queryOnlyOnOff*.
 
-<img src="/Homeware-LAN/img/create-device/C2.png"/>
+<img src="/img/create-device/C2.png"/>
 
 In the *Color setting* trait we can enable *Color type*, *Minimum temperature*, *Maximum temperature* and *commandOnlyColorSetting*.
 
-<img src="/Homeware-LAN/img/create-device/C3.png"/>
+<img src="/img/create-device/C3.png"/>
 
 ## Save
 

diff --git a/docs/src/pages/api.js b/docs/src/pages/api.js
@@ -8,7 +8,7 @@ function API() {
 
   return (
     <Layout title="API">
-      <iframe src="/Homeware-LAN/api-build/" style={{width: '100%', height: height}}/>
+      <iframe src="/api-build/" style={{width: '100%', height: height}}/>
     </Layout>
   );
 }

diff --git a/docs/static/api-build/index.html b/docs/static/api-build/index.html
@@ -39,7 +39,7 @@
     window.onload = function() {
       // Begin Swagger UI call region
       const ui = SwaggerUIBundle({
-        url: "/Homeware-LAN/api-build/swagger.json",
+        url: "/api-build/swagger.json",
         dom_id: '#swagger-ui',
         deepLinking: true,
         presets: [