GitHub user breautek added a comment to the discussion: Show full npm package name in dependency graph
> What mean platforms *. Does this still exists? it's a [wildcard](https://en.wikipedia.org/wiki/Wildcard_character), the asterik is a very common character to represent a wildcard. It means all platforms. And I think Election is included in that and doesn't need to be added, unless if election has some special circumstance in it's architecture. iOS is explicitly mentioned to it's utility package that it depends on, `node-xcode`. OSX is obsolete and can probably actually be removed, as the OSX platform is deprecated. Note that this does not document the backing SDKs for each platform, it is only documenting the Cordova bits. So we don't need to explicitly document the third-party election package, or android SDK, etc. > Any other thoughts for this graph? I'm not entirely against showing the full name of the package, but the aim of the documentation is to present information in an understandable human-readable format. There is going to be a balance between clarity vs information overload. If the information is clear enough, additional information is most likely irrelevant information. To find this, you have to think about who the readers are and their likely current knowledge. Adding detail adds context. Adding detail also makes the message more complex and harder to read. And adding to the context has diminishing returns, so at some point the details will become not very relevant, if the context is already well established. I hope this makes sense. One way to decide if there is enough context or not is to apply the acid test, that is asking yourself if the reader will behave differently if they know this information. The target audience is a factor here. As an analogy, if the target audience is a web developer, they probably already know the difference between a click and a double-click and we probably don't need to explain that detail. If the target audience is an end product user, then explaining a click vs a double-click might be necessary. Personally I'd say that anyone reading the cordova readme docs is someone that is software development minded. They might not know the architecture of the cordova framework, but can probably understand package relationships. So I'd argue that there is enough context that the graph and the surrounding content that it is referring to cordova packages: <img width="782" height="481" alt="image" src="https://github.com/user-attachments/assets/65200d20-73f9-417b-9f78-993a7f22197d"; /> And if they search across Apache repositories for any of those terms in the chart, the cordova repository are typically found in the first few results. Additionally the same page underneath the diagram lists all the repositories, whose terms will be easily found. I won't veto a change to label the clouds with the full package name, but I don't think it's necessary either. GitHub link: https://github.com/apache/cordova/discussions/570#discussioncomment-14830413 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
