Skip to content

dedicated-guides #1185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/new-concept-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
33 changes: 2 additions & 31 deletions docs/new-guide-how-to-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
- [Copilot](new-concept-copilot.md)
26 changes: 26 additions & 0 deletions docs/new-guide-how-to-discover-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: new-guide-how-to-discover-services
title: How to Discover Services
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: How to Discover Services
title: How to Discover Services with Copilot?

---

:::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.md)
- [Platform](new-concept-platform.md)
- [Copilot](new-concept-copilot.md)
26 changes: 26 additions & 0 deletions docs/new-guide-how-to-generate-building-block-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
id: new-guide-how-to-generate-building-block-documentation
title: How to Generate Building Block Documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: How to Generate Building Block Documentation
title: How to Generate Building Block Documentation with Copilot

---

:::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.md)
- [Service Documentation](new-concept-marketplace.md)
- [Copilot](new-concept-copilot.md)
4 changes: 3 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'
],
},
{
Expand Down