search

langgenius / dify

Dify is an open-source LLM app development platform. Dify's intuitive interface combines AI workflow, RAG pipeline, agent capabilities, model management, observability features and more, letting you quickly go from prototype to production.
https://dify.ai
Other
38.14k stars 5.2k forks source link

The Chinese documentation about workflow is missing images of creation entry. #3209

Closed ChildWangWorld closed 3 months ago

ChildWangWorld commented 3 months ago

Self Checks

Provide a description of requested docs changes

https://docs.dify.ai/v/zh-hans/guides/workflow/key_concept image

dosubot[bot] commented 3 months ago

Hey @doucheng, long time no see in the digital realm! Hope you're coding away without too many semicolon mysteries. 🕵️‍♂️👾

Thank you for bringing this to our attention. It's crucial that our documentation is complete and accessible to all users, regardless of their language preference.

To address this issue, you should report it through the Dify GitHub repository's documentation issue reporting system. Here's how you can do it based on the provided .github/ISSUE_TEMPLATE/document_issue.yml file:

  1. Search for Existing Issues: Before creating a new issue, ensure that there isn't already an issue reported for the same problem by searching through the existing issues, including the closed ones.

  2. Use English for the Report: Make sure to submit your report in English, as per the Language Policy mentioned in the issue template.

  3. Do Not Modify the Template: Fill in all the required fields without modifying the template to ensure your issue is understood and addressed promptly.

  4. Describe the Documentation Changes Needed: In the section provided for describing the requested documentation changes, clearly state that the Chinese documentation for the workflow creation process on the Dify platform is missing crucial images. Mention the specific sections where images are missing, such as "Chatflow," "Workflow," "Error," and "LLM," and emphasize the importance of these images for understanding the workflow creation process, especially the "Workflow ID" input field.

Here is an example of how you might fill out the relevant section:

**Provide a description of requested docs changes**
The Chinese version of the documentation for the Dify platform, specifically on the page https://docs.dify.ai/v/zh-hans/guides/workflow/key_concept, is missing images that are crucial for understanding the workflow creation process. This issue affects several sections, including "Chatflow," "Workflow," "Error," and "LLM," with a particular focus on the "Workflow ID" input field. These images are essential for users to fully grasp how to create and manage workflows on the platform. Restoring or updating these images would significantly improve the usability and comprehensibility of the documentation for Chinese-speaking users.

Remember to check the required boxes in the "Self Checks" section to confirm you've followed the necessary preliminary steps before submitting the issue.

As for the structure of the Dify documentation and how images are typically embedded within it, the documentation includes sections like Introduction and Links, Description, Cloud Services, Features, Comparison Table, Getting Started, Community and Support, and License. Images are typically embedded within the documentation using Markdown image syntax ![](path_to_image). For example, the models feature is illustrated with an image embedded using ![](./images/models.png). Additionally, the documentation uses clickable image links, such as [![](./images/GitHub_README_cover.png)](https://dify.ai), to make the cover image a link to the Dify website.

Unfortunately, I couldn't find any specific guidelines or standards for the images used in the Dify documentation within the repository. However, it's generally good practice to ensure that images are clear, relevant, and appropriately sized for the content they're supporting. If you have any further questions or need additional assistance, please don't hesitate to ask.

Sources

#### About Dosu This response is meant to be useful and save you time. It is **not meant to be a precise solution**, but rather a starting point for your own research. Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant. If you want to continue the conversation, start your reply with @dosu-bot.
VincePotato commented 3 months ago

Fixed.