mirror of
https://github.com/langgenius/dify-docs.git
synced 2026-03-27 13:28:32 +07:00
add Agents.md
This commit is contained in:
50
AGENTS.md
Normal file
50
AGENTS.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Mintlify documentation
|
||||
|
||||
## Working relationship
|
||||
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
|
||||
- ALWAYS ask for clarification rather than making assumptions
|
||||
- NEVER lie, guess, or make up anything
|
||||
|
||||
## Project context
|
||||
- Format: MDX files with YAML frontmatter
|
||||
- Config: docs.json for navigation, theme, settings
|
||||
- Components: Mintlify components
|
||||
|
||||
## Content strategy
|
||||
- Document just enough for user success - not too much, not too little
|
||||
- Prioritize accuracy and usability
|
||||
- Make content evergreen when possible
|
||||
- Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason
|
||||
- Check existing patterns for consistency
|
||||
- Start by making the smallest reasonable changes
|
||||
|
||||
## docs.json
|
||||
|
||||
- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation
|
||||
|
||||
## Frontmatter requirements for pages
|
||||
- title: Clear, descriptive page title
|
||||
- description: Concise summary for SEO/navigation
|
||||
|
||||
## Writing standards
|
||||
- Second-person voice ("you")
|
||||
- Prerequisites at start of procedural content
|
||||
- Test all code examples before publishing
|
||||
- Match style and formatting of existing pages
|
||||
- Include both basic and advanced use cases
|
||||
- Language tags on all code blocks
|
||||
- Alt text on all images
|
||||
- Relative paths for internal links
|
||||
|
||||
## Git workflow
|
||||
- NEVER use --no-verify when committing
|
||||
- Ask how to handle uncommitted changes before starting
|
||||
- Create a new branch when no clear branch exists for changes
|
||||
- Commit frequently throughout development
|
||||
- NEVER skip or disable pre-commit hooks
|
||||
|
||||
## Do not
|
||||
- Skip frontmatter on any MDX file
|
||||
- Use absolute URLs for internal links
|
||||
- Include untested code examples
|
||||
- Make assumptions - always ask for clarification
|
||||
19
docs.json
19
docs.json
@@ -273,25 +273,10 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Development Guides",
|
||||
"group": "Features & Specs",
|
||||
"pages": [
|
||||
{
|
||||
"group": "Plugin Types",
|
||||
"pages": [
|
||||
"plugin-dev-en/0222-creating-new-model-provider",
|
||||
"plugin-dev-en/0222-tool-plugin",
|
||||
"plugin-dev-en/9433-agent-strategy-plugin",
|
||||
"plugin-dev-en/9231-extension-plugin"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Development",
|
||||
"pages": [
|
||||
"plugin-dev-en/0411-remote-debug-a-plugin"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Features & Specs",
|
||||
"pages": [
|
||||
"plugin-dev-en/0411-general-specifications",
|
||||
"plugin-dev-en/0411-model-designing-rules",
|
||||
@@ -321,7 +306,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Examples & Use Cases",
|
||||
"group": "Development Guides",
|
||||
"pages": [
|
||||
"plugin-dev-en/0432-develop-a-slack-bot-plugin",
|
||||
"plugin-dev-en/0432-endpoint"
|
||||
|
||||
@@ -16,7 +16,7 @@ description: Authors Yeuoly, Allen. This document details the structure and impl
|
||||
|
||||
# Endpoint
|
||||
|
||||
This document uses the [Neko Cat](/plugin-dev-en/9231-extension-plugin.mdx) project as an example to explain the structure of Endpoints within a plugin. Endpoints are HTTP interfaces exposed by the plugin, which can be used for integration with external systems. For the complete plugin code, please refer to the [GitHub repository](https://github.com/langgenius/dify-plugin-sdks/tree/main/python/examples/neko).
|
||||
This document uses the [Neko Cat](/plugin-dev-en/9231-extension-plugin) project as an example to explain the structure of Endpoints within a plugin. Endpoints are HTTP interfaces exposed by the plugin, which can be used for integration with external systems. For the complete plugin code, please refer to the [GitHub repository](https://github.com/langgenius/dify-plugin-sdks/tree/main/python/examples/neko).
|
||||
|
||||
### Group Definition
|
||||
|
||||
@@ -30,7 +30,7 @@ Besides the `Endpoint Name`, you can add new form items by writing the group's c
|
||||
|
||||
#### **Structure**
|
||||
|
||||
* `settings` (map[string] [ProviderConfig](/plugin-dev-en/0411-general-specifications.mdx#providerconfig)): Endpoint configuration definition. (Note: Assuming the anchor `#providerconfig` exists in the target file).
|
||||
* `settings` (map[string] [ProviderConfig](/plugin-dev-en/0411-general-specifications#providerconfig)): Endpoint configuration definition.
|
||||
* `endpoints` (list[string], required): Points to the specific `endpoint` interface definitions.
|
||||
|
||||
```yaml
|
||||
@@ -108,13 +108,13 @@ class Duck(Endpoint):
|
||||
* Pay attention to security when developing Endpoints and avoid executing dangerous operations.
|
||||
* Endpoints can be used to handle Webhook callbacks or provide interfaces for other systems to connect.
|
||||
|
||||
If you are learning plugin development, it is recommended to first read the [Getting Started with Plugin Development](/plugin-dev-en/0211-getting-started-dify-tool.mdx) and the [Developer Cheatsheet](/plugin-dev-en/0131-cheatsheet.mdx).
|
||||
If you are learning plugin development, it is recommended to first read the [Getting Started with Plugin Development](/plugin-dev-en/0211-getting-started-dify-tool) and the [Developer Cheatsheet](/plugin-dev-en/0131-cheatsheet).
|
||||
|
||||
## Related Resources
|
||||
|
||||
* [Basic Concepts of Plugin Development](/plugin-dev-en/0111-getting-started-dify-plugin.mdx) - Understand the overall architecture of plugin development.
|
||||
* [Neko Cat Example](/plugin-dev-en/9231-extension-plugin.mdx) - An example of extension plugin development.
|
||||
* [General Specifications Definition](/plugin-dev-en/0411-general-specifications.mdx) - Understand common structures like ProviderConfig.
|
||||
* [Develop a Slack Bot Plugin Example](/plugin-dev-en/0432-develop-a-slack-bot-plugin.mdx) - Another plugin development example.
|
||||
* [Getting Started with Plugin Development](/plugin-dev-en/0211-getting-started-dify-tool.mdx) - Develop a plugin from scratch.
|
||||
* [Reverse Invocation of Dify Services](/plugin-dev-en/9241-reverse-invocation-app.mdx) - Learn how to use the reverse invocation feature. (Note: Link updated to closest available English document)
|
||||
* [Basic Concepts of Plugin Development](/plugin-dev-en/0111-getting-started-dify-plugin) - Understand the overall architecture of plugin development.
|
||||
* [Neko Cat Example](/plugin-dev-en/9231-extension-plugin) - An example of extension plugin development.
|
||||
* [General Specifications Definition](/plugin-dev-en/0411-general-specifications) - Understand common structures like ProviderConfig.
|
||||
* [Develop a Slack Bot Plugin Example](/plugin-dev-en/0432-develop-a-slack-bot-plugin) - Another plugin development example.
|
||||
* [Getting Started with Plugin Development](/plugin-dev-en/0211-getting-started-dify-tool) - Develop a plugin from scratch.
|
||||
* [Reverse Invocation of Dify Services](/plugin-dev-en/9242-reverse-invocation-app) - Learn how to use the reverse invocation feature.
|
||||
|
||||
Reference in New Issue
Block a user