From 28f5d6112ed314854b5c1aeabb95ac201f6e4b95 Mon Sep 17 00:00:00 2001 From: rebecca bausinger Date: Thu, 7 Aug 2025 17:13:54 +0200 Subject: [PATCH 1/3] dedicated-guides --- docs/new-concept-copilot.md | 10 +++++- docs/new-guide-how-to-copilot.md | 33 ++----------------- docs/new-guide-how-to-discover-services.md | 26 +++++++++++++++ ...o-generate-building-block-documentation.md | 26 +++++++++++++++ sidebars.ts | 4 ++- 5 files changed, 66 insertions(+), 33 deletions(-) create mode 100644 docs/new-guide-how-to-discover-services.md create mode 100644 docs/new-guide-how-to-generate-building-block-documentation.md diff --git a/docs/new-concept-copilot.md b/docs/new-concept-copilot.md index 51908134f..1e7baf9b3 100644 --- a/docs/new-concept-copilot.md +++ b/docs/new-concept-copilot.md @@ -93,5 +93,13 @@ All conversations with meshStack Copilot, including all data provided to the mod ## Related Resources -- [How to use meshStack Copilot Guide](new-guide-how-to-copilot.md) +### Concepts + +- [Copilot](new-concept-copilot.md) - [Security FAQ](security-faq.md) + +### Guides + +- [How to use meshStack Copilot Guide](new-guide-how-to-copilot.md) +- [How to Discover Services Guide](new-guide-how-to-discover-services.md) +- [How to Generate Building Block Documentation Guide](new-guide-how-to-generate-building-block-documentation.md) diff --git a/docs/new-guide-how-to-copilot.md b/docs/new-guide-how-to-copilot.md index 1d99571b6..a1ac8d0dd 100644 --- a/docs/new-guide-how-to-copilot.md +++ b/docs/new-guide-how-to-copilot.md @@ -7,35 +7,7 @@ title: How to Use meshStack Copilot This guide shows you how to get the most out of meshStack Copilot, your AI-powered assistant for discovering platform services, generating documentation, and improving your cloud experience. ::: -## Challenge - -Finding the right platform services, keeping documentation up to date, and understanding user needs can be tough. meshStack Copilot helps you solve these challenges by providing instant answers, documentation support, and actionable insights—all in one place. - -## Discover Platform Services - -### Prerequisites - -- You have access to meshPanel with Copilot enabled. - -### Step by Step Guide - -1. Click the Copilot sheep icon at the top right corner of any meshPanel screen. -2. Use the chat interface to ask questions about available services, policies, or how to get started with a specific tool. -3. Copilot will recommend services and guide you on how to request access. - -## Generate Service Documentation - -### Prerequisites - -- You have access to meshPanel with Copilot enabled. -- You are defining a building block or service. - -### Step by Step Guide - -1. Use Copilot’s “Get help” button when defining a building block or service. -2. Answer Copilot’s prompts to generate best-practices documentation, including descriptions, usage instructions, and troubleshooting guides. - -## Improve Services with User Insights +## Improve Answers with User Insights ### Prerequisites @@ -66,5 +38,4 @@ Use Copilot’s “Get help” button for context-aware suggestions and faster w ### Concepts -- [meshStack Copilot Concept](new-concept-copilot.md) -- [Marketplace](new-concept-marketplace.md) \ No newline at end of file +- [Copilot](new-concept-copilot.md) diff --git a/docs/new-guide-how-to-discover-services.md b/docs/new-guide-how-to-discover-services.md new file mode 100644 index 000000000..602e625d0 --- /dev/null +++ b/docs/new-guide-how-to-discover-services.md @@ -0,0 +1,26 @@ +--- +id: new-guide-how-to-discover-services +title: How to Discover Services +--- + +:::note What is this guide about? +This guide shows you how to use Copilot in meshPanel to discover available services, ask questions, and get recommendations tailored to your needs. +::: + +## Prerequisites + +- You have access to meshPanel with Copilot enabled. + +## Step by Step Guide + +1. Click the Copilot sheep icon at the top right corner of any meshPanel screen. +2. Use the chat interface to ask questions about available services, policies, or how to get started with a specific tool. +3. Copilot will recommend services and guide you on how to request access. + +## Related Resources + +### Concepts + +- [Marketplace](new-concept-marketplace) +- [Platform](new-concept-platform) +- [Copilot](new-concept-copilot.md) diff --git a/docs/new-guide-how-to-generate-building-block-documentation.md b/docs/new-guide-how-to-generate-building-block-documentation.md new file mode 100644 index 000000000..7147bcc7c --- /dev/null +++ b/docs/new-guide-how-to-generate-building-block-documentation.md @@ -0,0 +1,26 @@ +--- +id: new-guide-how-to-generate-building-block-documentation +title: How to Generate Building Block Documentation +--- + +:::note What is this guide about? +This guide shows you how to use Copilot in meshPanel to quickly generate high-quality documentation for your building blocks and services. +::: + +## Prerequisites + +- You have access to meshPanel with Copilot enabled. +- You are defining a building block or service. + +## Step by Step Guide + +1. Use Copilot’s “Get help” button when defining a building block or service. +2. Answer Copilot’s prompts to generate best-practices documentation, including descriptions, usage instructions, and troubleshooting guides. + +## Related Resources + +### Concepts + +- [Building Block](new-concept-buildingblock) +- [Service Documentation](new-concept-marketplace) +- [Copilot](new-concept-copilot.md) diff --git a/sidebars.ts b/sidebars.ts index 609ce43f4..7bbaa3381 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -328,7 +328,9 @@ const sidebars: SidebarsConfig = { label: 'Developer Engagement', items: [ 'new-guide-how-to-provide-security-contact', - 'new-guide-how-to-copilot' + 'new-guide-how-to-copilot', + 'new-guide-how-to-discover-services', + 'new-guide-how-to-generate-building-block-documentation' ], }, { From 10282a8cd12634fb03bb318574fd6ec1ad47c9d3 Mon Sep 17 00:00:00 2001 From: rebecca bausinger Date: Thu, 7 Aug 2025 17:52:29 +0200 Subject: [PATCH 2/3] fixed-links --- docs/new-guide-how-to-discover-services.md | 4 ++-- .../new-guide-how-to-generate-building-block-documentation.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/new-guide-how-to-discover-services.md b/docs/new-guide-how-to-discover-services.md index 602e625d0..4ca6782d9 100644 --- a/docs/new-guide-how-to-discover-services.md +++ b/docs/new-guide-how-to-discover-services.md @@ -21,6 +21,6 @@ This guide shows you how to use Copilot in meshPanel to discover available servi ### Concepts -- [Marketplace](new-concept-marketplace) -- [Platform](new-concept-platform) +- [Marketplace](new-concept-marketplace.md) +- [Platform](new-concept-platform.md) - [Copilot](new-concept-copilot.md) diff --git a/docs/new-guide-how-to-generate-building-block-documentation.md b/docs/new-guide-how-to-generate-building-block-documentation.md index 7147bcc7c..b95904294 100644 --- a/docs/new-guide-how-to-generate-building-block-documentation.md +++ b/docs/new-guide-how-to-generate-building-block-documentation.md @@ -21,6 +21,6 @@ This guide shows you how to use Copilot in meshPanel to quickly generate high-qu ### Concepts -- [Building Block](new-concept-buildingblock) -- [Service Documentation](new-concept-marketplace) +- [Building Block](new-concept-buildingblock.md) +- [Service Documentation](new-concept-marketplace.md) - [Copilot](new-concept-copilot.md) From 09fe5897e0a07d38c7cad414886dffb2f949bf17 Mon Sep 17 00:00:00 2001 From: rebecca bausinger Date: Mon, 11 Aug 2025 15:33:46 +0200 Subject: [PATCH 3/3] with-copilot-title --- docs/new-guide-how-to-discover-services.md | 2 +- docs/new-guide-how-to-generate-building-block-documentation.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/new-guide-how-to-discover-services.md b/docs/new-guide-how-to-discover-services.md index 4ca6782d9..45383b05c 100644 --- a/docs/new-guide-how-to-discover-services.md +++ b/docs/new-guide-how-to-discover-services.md @@ -1,6 +1,6 @@ --- id: new-guide-how-to-discover-services -title: How to Discover Services +title: How to Discover Services with Copilot --- :::note What is this guide about? diff --git a/docs/new-guide-how-to-generate-building-block-documentation.md b/docs/new-guide-how-to-generate-building-block-documentation.md index b95904294..8c2368f34 100644 --- a/docs/new-guide-how-to-generate-building-block-documentation.md +++ b/docs/new-guide-how-to-generate-building-block-documentation.md @@ -1,6 +1,6 @@ --- id: new-guide-how-to-generate-building-block-documentation -title: How to Generate Building Block Documentation +title: How to Generate Building Block Documentation with Copilot --- :::note What is this guide about?