Suggestion community: elaborate on sparse documentation

[DaphneMuller]

Feedback I received: "I am writing a new app and the vue components style guide is really helpful, but as you go down in the list the documentation gets sparser and sparser. Compare these two:

https://nextcloud-vue-components.netlify.app/#/Components/NcActions

https://nextcloud-vue-components.netlify.app/#/Components/NcVNodes"

[ShGKme]

NcVNodes is quite a technical component, more a rendering utility than a UI component, it has no configuration and just does what it says — renders vnodes.

NcActions is the opposite, it is a UI element with a huge number of use cases, configuration, specific usages, and accessibility concerns, requiring detailed documentation.

---

Missing docs:

• Function, mixins, composables - have no documentation at all. Its existence is barely mentioned
  • It definitely should be documented
  • directives: https://github.com/nextcloud-libraries/nextcloud-vue/pull/5665
  • function: https://github.com/nextcloud-libraries/nextcloud-vue/pull/5669
  • reference and registerReference: todo
  • composables: WIP @ShGKme
  • mixins: WIP @ShGKme
• NcEllipsisedOption, NcVNodes - missing docs
  • NcEllipsisedOption: https://github.com/nextcloud-libraries/nextcloud-vue/pull/5663
  • NcVNodes: https://github.com/nextcloud-libraries/nextcloud-vue/pull/5664
• Server-related components (not UI elements) such as NcRelatedResourcesPanel, NcResource, NcTeamResources, and interactive widgets.
  • These components are hard to document, and at the same time, they are not widely used. I'd propose using https://mswjs.io to document it if we need it
  • NcRelatedResourcesPanel: todo
  • NcResource: todo
  • NcTeamResources: todo

[mickenordin]

It would be helpful if something like your comment about NcVNodes were visible on the documentation page (same thing for NcRelatedResourcesPanel, NcResource, NcTeamResource, etc or other things that is not meant for general consumption). Even if it is just a paragraph that says" "This is not the UI component you are looking for" so that we as consumers of the docs know that this is not something that is useful to us.

[ShGKme]

@mickenordin Done for NcVNodes, see: https://github.com/nextcloud-libraries/nextcloud-vue/pull/5664

[mickenordin]

@mickenordin Done for NcVNodes, see: #5664

Wow! Looks really good! Huge improvement!

Great job!