From 802feccfc3394785f4b982223c224df98ee6fbec Mon Sep 17 00:00:00 2001
From: Mickael Stanislas <contact@mickael-stanislas.com>
Date: Thu, 2 Jan 2025 13:23:33 +0100
Subject: [PATCH] docs: update documentation portal (#8)

---
 README.md                  |  2 +-
 docs/datasource_example.md |  6 +++++
 docs/getting-started.md    |  5 ++++
 docs/{why.md => index.md}  |  9 +++++++
 docs/logic.md              |  5 ++++
 docs/resource_example.md   |  5 ++++
 mkdocs.yml                 | 52 +++++++++++++++++++++++++++++++++++---
 7 files changed, 79 insertions(+), 5 deletions(-)
 rename docs/{why.md => index.md} (88%)

diff --git a/README.md b/README.md
index 9319f33..dc1b1bf 100644
--- a/README.md
+++ b/README.md
@@ -24,4 +24,4 @@ This is a try to solve these issues :
 
 ## Documentation
 
-For more information about the SuperSchema, please refer to the [documentation](https://github.frangipane.io/terraform/superschema/why).
+For more information about the SuperSchema, please refer to the [documentation](https://orange-cloudavenue.github.io/terraform-plugin-framework-superschema/).
diff --git a/docs/datasource_example.md b/docs/datasource_example.md
index cfa1411..42eb73b 100644
--- a/docs/datasource_example.md
+++ b/docs/datasource_example.md
@@ -1,3 +1,9 @@
+---
+icon: material/home
+hide: 
+    - navigation
+--- 
+
 # cloudavenue_iam_user (Data Source)
 
 The user data source allows you to read users in Cloud Avenue.
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 4d5f17a..9219720 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -1,3 +1,8 @@
+---
+hide: 
+    - navigation
+--- 
+
 # Getting Started
 
 The following is a technical documentation on how to use superschema in your Terraform project.
diff --git a/docs/why.md b/docs/index.md
similarity index 88%
rename from docs/why.md
rename to docs/index.md
index b112ce2..29947a3 100644
--- a/docs/why.md
+++ b/docs/index.md
@@ -1,3 +1,12 @@
+---
+icon: material/home
+hide: 
+    - navigation
+    - toc
+--- 
+
+# Overview
+
 SuperSchema allows you to write the Terraform schema for resources and datasources in a single definition, along with a common field that enables you to define default values. SuperSchema is compatible with [tfplugindocs](github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs).
 
 This is a try to solve these issues :
diff --git a/docs/logic.md b/docs/logic.md
index d1df824..24b138b 100644
--- a/docs/logic.md
+++ b/docs/logic.md
@@ -1,3 +1,8 @@
+---
+hide: 
+    - navigation
+--- 
+
 # SuperSchema logic
 
 ## superschema.Schema
diff --git a/docs/resource_example.md b/docs/resource_example.md
index a8bb8cf..9aa62c3 100644
--- a/docs/resource_example.md
+++ b/docs/resource_example.md
@@ -1,3 +1,8 @@
+---
+hide: 
+    - navigation
+--- 
+
 # cloudavenue_iam_user (Resource)
 
 The user resource allows you to manage local users in Cloud Avenue.
diff --git a/mkdocs.yml b/mkdocs.yml
index d5e0514..954d8cd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,9 +1,53 @@
-site_name: Terraform SuperSchema
+site_name: Terraform Framework SuperSchema
+
 
 theme:
   name: material
+  palette:
+    - scheme: orangeCorp
+  features:
+    # - navigation.sections
+    - navigation.tabs
+    - navigation.top
+    - content.code.annotate
+    - header.autohide
+    - navigation.instant
+  icon:
+    repo: fontawesome/brands/github-alt
+  favicon: https://opensource.orange.com/wp-content/themes/boosted/favicon.ico
+  logo: https://boosted.orange.com/docs/5.3/assets/brand/orange-logo.svg
+
+extra_css:
+  - stylesheets/orange.css
 
 nav:
-  - Why ?: "why.md"
-  - How to use it: "getting-started.md"
-  - SuperSchema logic : "logic.md"
+  - Overview: "index.md"
+  - How to use: "getting-started.md"
+  - Logic : "logic.md"
+  - ⇗ Other projects: "https://orange-cloudavenue.github.io/projects"
+
+
+plugins:
+  - search
+
+markdown_extensions:
+  - attr_list
+  - md_in_html
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+
+repo_url: https://github.com/orange-cloudavenue/terraform-plugin-framework-planmodifiers
+repo_name: orange-cloudavenue/terraform-plugin-framework-planmodifiers
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/orange-cloudavenue
+
+copyright: Copyright &copy; Orange 2025
\ No newline at end of file