From bbc1dc5f1ac4548056dd86aefeb062e597ffdbb5 Mon Sep 17 00:00:00 2001 From: Hasith Yaggahavita Date: Sun, 8 Sep 2024 14:29:00 +0530 Subject: [PATCH] docs improveemnts --- docs/installation.md | 4 +++- docs/plugin-development.md | 13 ++++--------- docs/plugins/spotlight.md | 2 +- docs/plugins/tooltip.md | 4 ++-- 4 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 70e1eec..0e44143 100644 --- 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 index d733ae8..4cfd7e1 100644 --- 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", - + "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 index 2f4762e..7810525 100644 --- 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 index 0199f5b..89a6e81 100644 --- 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.