nextcloud-libraries / nextcloud-libraries/nextcloud-vue
Suggestion community: elaborate on sparse documentation
Open
@ShGKme is already working on this.
Since Jun 4, 2024.
feature: documentation
- Dominant language
- Vue
- Stars
- 246
- Forks
- 99
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 103
Description
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-
referenceandregisterReference: 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
Original text:
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"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.