Skip to content

Commit 9121371

Browse files
RiskeyLclaude
andcommitted
docs: adopt PR #817 readability polish for develop-plugin
Migrate the polished English develop-plugin pages from PR #817: heading capitalization, code-fence language tags, blockquote-to-callout conversions, and reworded prose across 39 pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 03825bb commit 9121371

39 files changed

Lines changed: 1206 additions & 1303 deletions

en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin.mdx

Lines changed: 61 additions & 71 deletions
Large diffs are not rendered by default.

en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,19 @@ dimensions:
77
standard_title: Cheatsheet
88
language: en
99
title: Cheatsheet
10-
description: A comprehensive reference guide for Dify plugin development, including
11-
environment requirements, installation methods, development process, plugin categories
12-
and types, common code snippets, and solutions to common issues. Suitable for developers
13-
to quickly consult and reference.
10+
description: A quick reference for Dify plugin development, covering environment setup, installation, the development process, and plugin types
1411
---
1512

1613
## Environment Requirements
1714

18-
- Python version 3.12
19-
- Dify plugin scaffold tool (dify-plugin-daemon)
15+
- Python version 3.12
16+
- Dify plugin scaffold tool (`dify-plugin-daemon`)
2017

21-
> Learn more: [Initializing Development Tools](/en/develop-plugin/getting-started/cli)
18+
For setup instructions, see [Initializing Development Tools](/en/develop-plugin/getting-started/cli).
2219

2320
## Obtain the Dify Plugin Development Package
2421

25-
[Dify Plugin CLI](https://github.com/langgenius/dify-plugin-daemon/releases)
22+
Download the [Dify Plugin CLI](https://github.com/langgenius/dify-plugin-daemon/releases) from the GitHub releases page.
2623

2724
### Installation Methods for Different Platforms
2825

@@ -71,7 +68,7 @@ dify version
7168

7269
## Run the Development Package
7370

74-
Here we use `dify` as an example. If you are using a local installation method, please replace the command accordingly, for example `./dify-plugin-darwin-arm64 plugin init`.
71+
The following examples use `dify` as the command. If you installed locally, replace the command accordinglyfor example, `./dify-plugin-darwin-arm64 plugin init`.
7572

7673
## Plugin Development Process
7774

@@ -81,9 +78,9 @@ Here we use `dify` as an example. If you are using a local installation method,
8178
./dify plugin init
8279
```
8380

84-
Follow the prompts to complete the basic plugin information configuration
81+
Follow the prompts to configure the basic plugin information.
8582

86-
> Learn more: [Dify Plugin Development: Hello World Guide](/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin)
83+
For a full walkthrough, see [Dify Plugin Development: Hello World Guide](/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin).
8784

8885
### 2. Run in Development Mode
8986

@@ -93,9 +90,9 @@ Configure the `.env` file, then run the following command in the plugin director
9390
python -m main
9491
```
9592

96-
> Learn more: [Remote Debugging Plugins](/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin)
93+
For debugging details, see [Remote Debugging Plugins](/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin).
9794

98-
### 3. Packaging and Deployment
95+
### 3. Package and Deploy
9996

10097
Package the plugin:
10198

@@ -104,13 +101,13 @@ cd ..
104101
dify plugin package ./yourapp
105102
```
106103

107-
> Learn more: [Publishing Overview](/en/develop-plugin/publishing/marketplace-listing/release-overview)
104+
For publishing details, see the [Publishing Overview](/en/develop-plugin/publishing/marketplace-listing/release-overview).
108105

109106
## Plugin Categories
110107

111108
### Tool Labels
112109

113-
Category `tag` [class ToolLabelEnum(Enum)](https://github.com/langgenius/dify-plugin-sdks/blob/main/python/dify_plugin/entities/tool.py)
110+
Category tags are defined in [`ToolLabelEnum`](https://github.com/langgenius/dify-plugin-sdks/blob/main/python/dify_plugin/entities/tool.py):
114111

115112
```python
116113
class ToolLabelEnum(Enum):
@@ -134,25 +131,14 @@ class ToolLabelEnum(Enum):
134131

135132
## Plugin Type Reference
136133

137-
Dify supports the development of various types of plugins:
134+
Dify supports several plugin types:
138135

139-
- **Tool plugin**: Integrate third-party APIs and services
140-
> Learn more: [Dify Plugin Development: Hello World Guide](/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin)
141-
142-
- **Model plugin**: Integrate AI models
143-
> Learn more: [Model Plugin](/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules), [Quick Integration of a New Model](/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider)
144-
145-
- **Agent strategy plugin**: Customize Agent thinking and decision-making strategies
146-
> Learn more: [Agent Strategy Plugin](/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation)
147-
148-
- **Extension plugin**: Extend Dify platform functionality, such as Endpoints and WebAPP
149-
> Learn more: [Extension Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/endpoint)
150-
151-
- **Data source plugin**: Serve as the document data source and starting point for knowledge pipelines
152-
> Learn more: [Data Source Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin)
153-
154-
- **Trigger plugin**: Automatically trigger Workflow execution upon third-party events
155-
> Learn more: [Trigger Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin)
136+
- **Tool plugin**: Integrate third-party APIs and services. See [Dify Plugin Development: Hello World Guide](/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin).
137+
- **Model plugin**: Integrate AI models. See [Model Plugin](/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules) and [Quick Integration of a New Model](/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider).
138+
- **Agent strategy plugin**: Customize Agent thinking and decision-making strategies. See [Agent Strategy Plugin](/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation).
139+
- **Extension plugin**: Extend Dify platform functionality, such as Endpoints and WebApp. See [Extension Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/endpoint).
140+
- **Data source plugin**: Serve as the document data source and starting point for knowledge pipelines. See [Data Source Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin).
141+
- **Trigger plugin**: Automatically trigger workflow execution on third-party events. See [Trigger Plugin](/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin).
156142

157143
{/*
158144
Contributing Section
@@ -163,4 +149,3 @@ It will be automatically generated by the script.
163149
---
164150

165151
[Edit this page](https://github.com/langgenius/dify-docs/edit/main/en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx) | [Report an issue](https://github.com/langgenius/dify-docs/issues/new?template=docs.yml)
166-

0 commit comments

Comments
 (0)