This document helps you quickly define core metadata for Dify developer documentation. Correctly filling out these fields is key to implementing automated document structure and sorting.

​
Quick Start

  • Using AI Assistance
  • Manual Definition
1

Prepare document content

Complete writing your document content.
2

Generate metadata with AI

Provide your document and the content from dimensions system explained to your preferred large language model, and request it to generate appropriate Frontmatter.
3

Manual refinement

Based on actual circumstances and the detailed explanations below, make necessary adjustments and optimizations to the generated metadata.

​
Required Frontmatter Fields

Please add the following YAML Frontmatter at the beginning of each Markdown document: 
---
# --- Core System Metadata (affects structure and sorting) ---
dimensions:
  type:
    primary: <see options below>
    detail: <see options below>
  level: <see options below>
standard_title: 'Descriptive title in English, used for filename generation' # e.g., 'Getting Started Dify Plugin'
language: 'en' # or 'zh', 'ja', etc. (ISO 639-2 code)

# --- Page Content Metadata (optional but recommended) ---
title: 'H1 title or page title of the document'
description: 'Brief SEO description of the document content'
# summary: 'More detailed summary (optional)'
# tags: ['keywords'] (optional)
---

​
Understanding the dimensions Field

  • type.primary
  • type.detail
  • level

conceptual

Concepts, theory (what/why)
Focuses on explaining concepts and fundamental theories

implementation

Development practices, code (how to)
Focuses on providing implementation steps and code examples

operational

Operations, deployment (how to run)
Focuses on system operation and maintenance

reference

API, configuration reference (precise lookup)
Focuses on technical specifications and reference information

​
Other Important Fields

​
standard_title
string
required
Use English to clearly describe the core content of the document. The system will use this to generate part of the filename (e.g., Getting Started Dify Plugin).
​
language
string
required
ISO 639-2 two-letter language code (such as en, zh, ja).
​
title
string
The main title of the document displayed on the page, typically in the localized language.
​
description
string
A brief SEO description for search engines and previews.

​
Complete Examples

---
dimensions:
  type:
    primary: conceptual
    detail: introduction
  level: beginner
standard_title: 'Getting Started Dify Plugin'
language: en
title: 'Welcome to Dify Plugin Development'
description: 'Introduction to Dify plugin concepts, functionality, and development value, including a brief explanation of plugin types and an overview of developer documentation content.'
---
Example Interpretation: The first example is a beginner-oriented introductory document about Dify plugin concepts in English. The system will automatically place it correctly in the document structure based on the metadata.

​
Document Automation Processing

  • Local Development
  • GitHub Editing
Run tools/main_docs_bundle.py, and the document will automatically complete the following operations based on the Frontmatter:
1

Rename Files

The system will automatically generate standardized filenames based on dimensions and standard_title.
2

Update Navigation

Documents will be automatically injected into the docs.json navigation configuration.
3

Add Interactive Components

Automatically refresh contribution and feedback buttons and other interactive components.
When developing documentation in a local environment, it’s recommended to run this script to ensure document configurations take effect correctly.

Want to learn more?

If you’re interested in the design philosophy of the Dimensions system, the complete details of the sorting mechanism, or roles and governance, please read the full Dimensions system detailed explanation document.
Edit this page | Report an issue