docs improveemnts

raqeebr · Sep 8, 2024 · bbc1dc5 · bbc1dc5
1 parent 7c297e2
commit bbc1dc5
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -5,11 +5,13 @@ nav_order: 2
 ---
 
 # Installation Guide 
+
 {: .no_toc }
 
 Welcome to the Productled Library Installation Guide. This guide will walk you through the process of setting up and configuring the Productled Library in your project. By following these steps, you'll be able to leverage the powerful features provided by Productled to enhance your application's user experience.
 
-## Table of contents 
+## Table of contents
+
 {: .no_toc .text-delta }
 
 1. TOC

diff --git a/docs/plugin-development.md b/docs/plugin-development.md
@@ -1,5 +1,5 @@
 ---
-title: Installation
+title: Plugin Development
 layout: home
 nav_order: 5
 ---
@@ -16,14 +16,9 @@ in the solution root's package.json add an new entry to the workspaces array wit
 
 ```json
 {
-    ...
   "workspaces": [
-    "packages/@productled/core",
-    "packages/@productled/spotlights",
-    "packages/samples/react-sample",
-    <add new plugin path here>
+    "packages/@productled/new-plugin-path
   ],
-    ...
 }
 ```
 
@@ -65,8 +60,8 @@ In the new plugin folder, create a `tsconfig.json` file with the following conte
       "target": "ESNext",
       "moduleResolution": "node",
       "esModuleInterop": true,
-      "declaration": true, // set to true on prod
-      "sourceMap": true, // set to true on dev
+      "declaration": true,
+      "sourceMap": true, 
       "strict": true,
       "types": ["node"]
     },

diff --git a/docs/plugins/spotlight.md b/docs/plugins/spotlight.md
@@ -4,7 +4,7 @@ parent: Plugins
 nav_order: 2
 ---
 
-# Spotlights Plugin Documentation
+# Spotlights Plugin
 
 The Spotlights plugin is a powerful tool that allows you to create in-app spotlights to guide users through new features, highlight important UI elements. This guide will walk you through the installation process and show you how to configure the Spotlights plugin within Productled.
 

diff --git a/docs/plugins/tooltip.md b/docs/plugins/tooltip.md
@@ -1,10 +1,10 @@
 ---
-title: Spotlights
+title: Tooltip
 parent: Plugins
 nav_order: 2
 ---
 
-# Tooltip Plugin Documentation
+# Tooltip Plugin
 
 The Tooltip Plugin provides a way to display helpful tooltips to users when they hover over specific elements in your application. This guide covers the installation and configuration steps to get the Tooltip plugin working with Productled.