Fix doc reference path

.gitlab-ci.yml

@@ -2,6 +2,10 @@ include:
   - project: 'iopsys/gitlab-ci-pipeline'
     file: '/static-code-analysis.yml'
 
+include:
+  - project: 'docs/portal2/pipeline-template'
+    file: 'MkDocs.gitlab-ci.yml'
+
 variables:
   DEBUG: 'TRUE'
   COMMON_IMAGE: "iopsys/code-analysis:0.27"
@@ -16,6 +20,7 @@ stages:
     - static_code_analysis
     - unit_test
     - functional_test
+    - deploy
     
 run_unit_test:
    stage: unit_test

README.md

@@ -54,6 +54,7 @@ uci commit cwmp
 > icwmpd gets the datamodel from the DUT via ubus using uspd, and also it registers `tr069` ubus namespace to expose some debug and cwmp client rpc funtionalities, so it is required to start it after starting `ubusd` and `uspd`.
 
 ## Important topics
+* [icwmp design](./docs/arch/design.md)
 * [Concepts & Workflow](./docs/guide/workflow.md)
 * [Provisioning via DHCP](./docs/guide/dhcp_provisioning.md)
 * [HTTPS configuration guide](./docs/guide/https_config.md)
@@ -63,7 +64,6 @@ uci commit cwmp
 * [Supported RPC Methods](./docs/guide/supported_rpc.md)
 * [UBUS methods](./docs/guide/ubus_method.md)
 * [Command Line Interface](./docs/guide/cli.md)
-* [icwmp design](./docs/design.md)
 
 ## Dependencies
 

mkdocs.yml

@@ -0,0 +1,90 @@
+site_name: BroadBand Forum Data Models (BBFDM)
+site_url: https://dev.iopsys.eu/iopsys/icwmp
+edit_uri: "https://dev.iopsys.eu/iopsys/icwmp"
+
+site_description: IOWRT Technical Documentation
+site_author: IOPSYS
+
+docs_dir: 'docs'
+site_dir: 'site'
+
+
+theme:
+  name: material
+  include_sidebar: true
+  highlightjs: true
+  hljs_languages:
+      - yaml
+      - python
+  language: en
+  font:
+    text: Roboto
+    code: Roboto Mono
+  logo: iopsys-white.svg
+  icon:
+    logo: icon.png
+    repo: fontawesome/brands/gitlab
+  extra:
+    social:
+      - icon: fontawesome/brands/github-alt
+        link: https://github.com/squidfunk
+  features:
+    - toc.autohide
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - navigation.expand
+
+  palette:
+    # Primary color used for header, sidebar and links, default: indigo
+    primary: black
+    # Accent color for highlighting user interaction, default: indigo
+    accent: deep orange
+
+extra_css:
+  - css/extra.css
+  - https://unpkg.com/mermaid@8.5.1/dist/mermaid.css
+  - https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.css
+
+extra_javascript:
+  - https://unpkg.com/mermaid/dist/mermaid.min.js
+  - https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js
+  - https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.js
+
+markdown_extensions:
+  - meta
+  - admonition
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+     emoji_index: !!python/name:materialx.emoji.twemoji
+     emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.superfences:
+      # make exceptions to highlighting of code:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:mermaid2.fence_mermaid
+  - fontawesome_markdown
+
+plugins:
+  - search:
+      lang:
+        - en
+      separator: '[\s\-\.]+'
+  - awesome-pages:
+        collapse_single_pages: true
+  - mermaid2
+  - section-index