Skip to content

docs: improve readability across develop-plugin section#817

Open
crazywoola wants to merge 2 commits into
mainfrom
docs/polish-develop-plugin
Open

docs: improve readability across develop-plugin section#817
crazywoola wants to merge 2 commits into
mainfrom
docs/polish-develop-plugin

Conversation

@crazywoola

Copy link
Copy Markdown
Member

What

A full editorial pass over all 39 pages in en/develop-plugin/ to make the section read like professional, native-English technical writing. Changes follow writing-guides/style-guide.md and writing-guides/formatting-guide.md.

  • Removed machine-translation artifacts and leftover translator notes (e.g. "(or something that looks like a bug)", "(Please refer to your local corresponding screenshot...)" in cli.mdx, "which can be understood as", "This example means requesting...").
  • Rewrote awkward or robotic phrasing into direct, natural English; cut filler ("in order to", "please note that", "This guide will instruct you on how to...").
  • Normalized headings: title case, imperative base-form verbs, no bold inside headings, fixed H2→H3→H4 hierarchy mismatches (e.g. cli.mdx now has a proper "Install the CLI" section).
  • Converted blockquote pseudo-callouts to Mintlify <Note>/<Tip>/<Warning>; consolidated stacked callouts.
  • Applied the bold-label + colon pattern to field/parameter reference lists with consistent required/optional markers and backticked field names.
  • Replaced bloated multi-sentence frontmatter descriptions with one concise line; dimensions, standard_title, language untouched.
  • Mechanical fixes: - list markers, blank lines around lists/code blocks, em dash spacing, code fence language tags, trailing blank lines at EOF, UI labels in bold.

What did NOT change

  • No technical claims, commands, YAML keys/values, URLs, or code logic. Code blocks were touched only for comment/docstring grammar.
  • contributor-covenant-code-of-conduct.mdx (standard covenant text) and auto-generated contributing footers are untouched.
  • docs.json untouched; zh/ja sync via the translation pipeline.

Verification

  • check-format-en.py (format-check skill linter) run on all 39 files: all real violations fixed; remaining flags are component-adjacent blank-line false positives that match the formatting guide's own <Tabs>/<CodeGroup> examples.
  • Verified programmatically that fenced code blocks differ only in comments/docstrings, all Mintlify component tags are balanced, and contributing footers are intact.

Follow-up: suspect technical claims (left unchanged, need verification against the codebase)

The pass surfaced statements that look wrong or outdated but were deliberately not changed, since this PR is editorial only:

  • tool-plugin.mdx: manifest snippet implies google.yaml lives in the project root while the prose says /provider; current scaffolds reference provider/google.yaml.
  • agent-strategy-plugin.mdx: the "Handle Tools" and "Invoke Model" tabs contain byte-identical sample code; samples invoke each tool twice with a dead if not tool_instance guard.
  • model-schema.mdx: says "five model types" but documents six (incl. Moderation); PromptMessageContentType lists only TEXT/IMAGE; _get_num_tokens vs get_num_tokens naming mismatch.
  • creating-new-model-provider.mdx / develop-md-exporter.mdx: several import paths and SDK APIs (dify_plugin.provider_kits.llm, PluginRunner, create_file_message, credential_schema/tool_schema keys) don't match the current dify_plugin SDK.
  • Debug host inconsistency across pages: debug.dify.ai:5003 vs debug-plugin.dify.dev:5003.
  • release-to-dify-marketplace.mdx / faq.mdx: minimum SDK pin documented as 0.5.0, but current review tooling checks 0.9.0; the two pages also attribute the stale-PR trigger to different parties.
  • trigger-plugin.mdx: prose says dispatch_event while the code reference shows _dispatch_event; GitHub webhook secrets described as "encryption" rather than HMAC signature verification.
  • datasource-plugin.mdx: _get_pages example contains pages.length() (invalid Python) and pages=[page]; "official Google Drive plugin" link points to the Google Cloud Storage plugin.
  • plugin-auto-publish-pr.mdx: workflow YAML pushes branch bump-{plugin}-{version} but gh pr create --head references a different ref.
  • Several self-links / duplicate link targets in Related Resources sections (endpoint.mdx, model-schema.mdx, model-designing-rules.mdx, plugin-info-by-manifest.mdx).

🤖 Generated with Claude Code

Editorial pass over all 39 pages in en/develop-plugin/: removed
machine-translation artifacts and translator notes, rewrote awkward
phrasing into direct natural English, normalized headings to title
case and imperative form, converted blockquote callouts to Mintlify
components, applied the bold-label list pattern to field references,
tightened bloated frontmatter descriptions, and fixed mechanical
formatting (list markers, blank lines, em dashes, code fence tags).

No technical content changed: commands, YAML keys/values, code logic,
URLs, and behavior claims are preserved verbatim; code blocks were
touched only for comment/docstring grammar.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@crazywoola crazywoola requested a review from RiskeyL as a code owner June 10, 2026 05:35
Copilot AI review requested due to automatic review settings June 10, 2026 05:35
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. documentation Improvements or additions to documentation labels Jun 10, 2026
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR performs an editorial/formatting pass across the en/develop-plugin/ documentation to improve readability and consistency with the documentation style/formatting guides.

Changes:

  • Normalizes headings (title case + hierarchy), and rewrites paragraphs/lists for clearer, more natural technical English.
  • Standardizes formatting patterns (lists, callouts/components, code fences/language tags, and “Related Resources” sections).
  • Cleans up scattered grammar/wording issues across getting-started, specs, and publishing pages.

Reviewed changes

Copilot reviewed 39 out of 39 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
en/develop-plugin/publishing/standards/third-party-signature-verification.mdx Normalizes section headings for readability/consistency.
en/develop-plugin/publishing/standards/privacy-protection-guidelines.mdx Rephrases intro question and standardizes headings/casing.
en/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo.mdx Reworks headings and list styling; improves troubleshooting/related links formatting.
en/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace.mdx Updates frontmatter description and standardizes headings/callouts.
en/develop-plugin/publishing/marketplace-listing/release-overview.mdx Standardizes headings and “Related Resources” section title casing.
en/develop-plugin/publishing/marketplace-listing/release-by-file.mdx Standardizes headings and improves a sentence for clarity.
en/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr.mdx Rewrites and restructures workflow automation doc for clarity and consistent formatting.
en/develop-plugin/publishing/faq/faq.mdx Normalizes heading title case throughout the FAQ.
en/develop-plugin/getting-started/getting-started-dify-plugin.mdx Tightens intro copy and normalizes heading/card titles/spacing.
en/develop-plugin/getting-started/cli.mdx Rewrites intro and restructures installation + project/run sections for clearer flow.
en/develop-plugin/getting-started/choose-plugin-type.mdx Normalizes headings and refines wording (including glossary-aligned casing).
en/develop-plugin/features-and-specs/plugin-types/tool.mdx Improves narrative clarity and standardizes parameter/return descriptions.
en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin.mdx Refines wording and standardizes “Related Resources” list formatting.
en/develop-plugin/features-and-specs/plugin-types/plugin-logging.mdx Simplifies intro text and renames “Sample” → “Example”.
en/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest.mdx Clarifies manifest overview and tightens ParamField descriptions/warnings.
en/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv.mdx Clarifies overview text and normalizes list capitalization/punctuation.
en/develop-plugin/features-and-specs/plugin-types/multilingual-readme.mdx Adjusts code fence language + image alt text wording for consistency.
en/develop-plugin/features-and-specs/plugin-types/model-schema.mdx Editorial improvements across API reference prose and entity section headings.
en/develop-plugin/features-and-specs/plugin-types/model-designing-rules.mdx Converts blockquote note to <Note> and normalizes ParamField descriptions.
en/develop-plugin/features-and-specs/plugin-types/general-specifications.mdx Rewrites descriptions for shared structures with consistent style and punctuation.
en/develop-plugin/features-and-specs/advanced-development/reverse-invocation.mdx Converts a fragmented list into a cleaner, scannable summary.
en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool.mdx Restructures interface docs into consistent “Entry Point / Interface” sections.
en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node.mdx Clarifies parameter explanations and heading formatting.
en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model.mdx Normalizes headings and clarifies interface descriptions/notes.
en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app.mdx Rewrites interface type descriptions for readability and consistency.
en/develop-plugin/features-and-specs/advanced-development/customizable-model.mdx Tightens language and improves structure of the Xinference walkthrough.
en/develop-plugin/features-and-specs/advanced-development/bundle.mdx Rewrites and restructures Bundle explanation and dependency sections.
en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin.mdx Improves prose/structure and formatting across the trigger walkthrough.
en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx Improves readability and standardizes formatting across the tool plugin walkthrough.
en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth.mdx Tightens prose and improves list/accordion formatting for OAuth setup guidance.
en/develop-plugin/dev-guides-and-walkthroughs/endpoint.mdx Improves image alt text, list formatting, and clarifies interface guidance.
en/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool.mdx Improves explanations and corrects code fence language tags for schema examples.
en/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter.mdx Normalizes headings and improves step formatting/code fence tags.
en/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin.mdx Normalizes headings and improves step formatting and code fence tags.
en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin.mdx Improves clarity, fixes alt text, and normalizes headings/lists.
en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin.mdx Improves readability and normalizes headings/code fence language tags.
en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider.mdx Normalizes bullets/structure and tightens explanations.
en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet.mdx Rewrites for concise reference-style wording and consistent formatting.
en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin.mdx Clarifies wording and normalizes headings/list formatting across tabs/sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread en/develop-plugin/features-and-specs/plugin-types/model-schema.mdx
Comment thread en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin.mdx
Comment thread en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth.mdx
Comment thread en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx
Comment thread en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin.mdx
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
dify-core-product 🟢 Ready View Preview Jun 10, 2026, 5:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown
Contributor

🌐 Multi-language Sync

✅ Created sync PR #818

Synced 20 files to cn + jp

Both PRs can merge independently. Future commits here will auto-update the sync PR.

RiskeyL added a commit that referenced this pull request Jun 17, 2026
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>
RiskeyL added a commit that referenced this pull request Jun 17, 2026
Bring the develop-plugin zh and ja pages in line with the current English. Around half the pages had been translated from a much older structure and were fully re-translated; the rest received the PR #817 readability polish.

Also normalize section metadata: set the language field per file (zh/ja), render "Dify Marketplace" as the product's own term (Dify 市场 / Dify マーケットプレイス), drop a stale todo field from the FAQ, and repoint four cross-page anchors to the current translated headings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants