feat: add links to doc

TerosTechnology · Oct 20, 2024 · a643a5a · a643a5a
1 parent a808d01
commit a643a5a
Show file tree

Hide file tree

Showing 20 changed files with 174 additions and 33 deletions.
diff --git a/auto_package/templates/devDependencie.nj b/auto_package/templates/devDependencie.nj
@@ -1,8 +1,6 @@
 "devDependencies": {
-    "@types/glob": "^7.1.1",
     "@types/node": "^17.0.31",
     "@types/vscode": "^1.45.0",
-    "glob": "^7.1.6",
     "js-yaml": "^3.13.1",
     "shx": "^0.3.3",
     "esbuild": "^0.16.17",

diff --git a/auto_package/templates/package.nj b/auto_package/templates/package.nj
@@ -81,7 +81,15 @@
         "viewsWelcome": [
             {
                 "view": "teroshdl-project",
-                "contents": "No TerosHDL project are open.\n[Add Project](command:teroshdl.view.project.add)\nTo learn more about how to use TerosHDL [read the documentation](https://terostechnology.github.io/terosHDLdoc/)."
+                "contents": "No TerosHDL project are open.\n[Add Project](command:teroshdl.view.project.add)\nTo learn more about how to [setup a TerosHDL project](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/)."
+            },
+            {
+                "view": "teroshdl-view-source",
+                "contents": "Learn more about how to [add files and libraries to a project](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/sources)."
+            },
+            {
+                "view": "teroshdl-view-dependency",
+                "contents": "Learn more about how to [setup TerosHDL to compute Hierarchy](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/hierarchy)."
             },
             {
                 "view": "teroshdl-view-actions",

diff --git a/package.json b/package.json
@@ -116,7 +116,15 @@
         "viewsWelcome": [
             {
                 "view": "teroshdl-project",
-                "contents": "No TerosHDL project are open.\n[Add Project](command:teroshdl.view.project.add)\nTo learn more about how to use TerosHDL [read the documentation](https://terostechnology.github.io/terosHDLdoc/)."
+                "contents": "No TerosHDL project are open.\n[Add Project](command:teroshdl.view.project.add)\nTo learn more about how to [setup a TerosHDL project](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/)."
+            },
+            {
+                "view": "teroshdl-view-source",
+                "contents": "Learn more about how to [add files and libraries to a project](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/sources)."
+            },
+            {
+                "view": "teroshdl-view-dependency",
+                "contents": "Learn more about how to [setup TerosHDL to compute Hierarchy](https://terostechnology.github.io/terosHDLdoc/docs/project_configuration/hierarchy)."
             },
             {
                 "view": "teroshdl-view-actions",
@@ -888,10 +896,8 @@
         "module-alias": "^2.2.3"
     },
     "devDependencies": {
-        "@types/glob": "^7.1.1",
         "@types/node": "^17.0.31",
         "@types/vscode": "^1.45.0",
-        "glob": "^7.1.6",
         "js-yaml": "^3.13.1",
         "shx": "^0.3.3",
         "esbuild": "^0.16.17",

diff --git a/src/colibri/config/config_web.ts b/src/colibri/config/config_web.ts
diff --git a/src/colibri/config/helpers/configs/documentation.yml b/src/colibri/config/helpers/configs/documentation.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/category/auto-documentation"
+
 language:
   description: "Documentation language:"
   type: select

diff --git a/src/colibri/config/helpers/configs/editor.yml b/src/colibri/config/helpers/configs/editor.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/category/editor"
+
 stutter_comment_shortcuts:
   description: 'Stutter mode: an enter keypress at the end of a line that contains a non-empty comment will continue the comment on the next line. This can be cancelled by pressing enter again. You must also set <code>"editor.formatOnType": true"</code>'
   type: boolean

diff --git a/src/colibri/config/helpers/configs/formatter/general.yml b/src/colibri/config/helpers/configs/formatter/general.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/guides/formatter"
+
 formatter_verilog:
   description: "Verilog/SV formatter:"
   type: select

diff --git a/src/colibri/config/helpers/configs/general.yml b/src/colibri/config/helpers/configs/general.yml
@@ -1,4 +1,4 @@
-docLink: "https://terostechnology.github.io/terosHDLdoc/"
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/installation_checklist/installation"
 
 pypath:
   description: "Python3 binary path (e.g.: /usr/bin/python3). Empty if you want to use the system path. <strong>Install teroshdl. E.g: pip3 install teroshdl</strong>"

diff --git a/src/colibri/config/helpers/configs/linter/general.yml b/src/colibri/config/helpers/configs/linter/general.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/guides/linter"
+
 linter_vhdl:
   description: "VHDL linter: disable VHDL-LS needs restart VSCode."
   type: select

diff --git a/src/colibri/config/helpers/configs/schematic.yml b/src/colibri/config/helpers/configs/schematic.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/guides/schematic_viewer/installation"
+
 backend:
   description: "Select the backend:"
   type: select

diff --git a/src/colibri/config/helpers/configs/templates.yml b/src/colibri/config/helpers/configs/templates.yml
@@ -1,3 +1,5 @@
+docLink: "https://terostechnology.github.io/terosHDLdoc/docs/guides/templates"
+
 header_file_path:
   description: "File path with your configurable header. E.g. your company license. It will be inserted at the beginning of the template"
   type: string