electron-userland / electron-builder

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box
https://www.electron.build
MIT License
13.46k stars 1.71k forks source link

The issue lies in the organization and clarity of the electron-builder documentation, as well as the lack of an explanation for the MetadataDirectories type and the purpose of directories. #8237

Open JohnBrayden opened 1 month ago

JohnBrayden commented 1 month ago

The issue lies in the organization and clarity of the electron-builder documentation, as well as the lack of an explanation for the MetadataDirectories type and the purpose of directories.

I would like to inquire about the type of MetadataDirectories in the electron-builder documentation, as it is not clear to me at all. I have searched for its type and couldn't find whether it is an array or an object, nor do I know what properties it contains. I searched the internet a bit and found that some of the properties of this type are output and app, but the problem is that the documentation itself does not explain or clarify them at all. Even after extensively searching the documentation for something clear to guide me, I found nothing.

I believe that the documentation needs a complete update because it lacks clarity and explanation. As we progress in technology, we have reached a point where documentation is clear, comprehensive, and includes simple and clear explanations in many technologies. However, the electron-builder documentation is still unorganized and unclear.

Furthermore, in the documentation, MetadataDirectories is indicated as a clickable link or button to understand its type, but when I click on it, nothing happens, and it does not take me to a page for clarification. It seems like a button without any purpose.

There is also no explanation of what exactly directories refers to. Are they the directories located in the dist folder? Or are they located somewhere else? What exactly is the purpose of specifying the directories?

All these matters are difficult to understand and comprehend without an explanation. Even if they are clear to some, not everyone has a high level of expertise or extraordinary intelligence to understand things without a clear (even if simple) explanation.