Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Component discovery docs #1244

Closed
pi0 opened this issue Feb 10, 2021 · 5 comments
Closed

Component discovery docs #1244

pi0 opened this issue Feb 10, 2021 · 5 comments
Assignees

Comments

@pi0
Copy link
Member

pi0 commented Feb 10, 2021

Currently we have sparse documentation about nuxt/components. Since this is an ad-hoc module (built-in feature with independent versioning) i think it would be the best to move and link docs from repo to official website so is easier for users to find all information in single place and avoid content to be stalled.

Goals:

  • Adding "Features > Components Discovery" section
  • Renaming "Features > Nuxt Components" to "Features > Components" (or built-in components?)
  • Update "Directory Structure > Components" with components v2 docs (to be released)
  • Update "Configuration Glossary > components" with detailed version of options (moving from repo)
  • [q] Where to put advanced docs about extending components with hooks (module authors) and diagram? We may add it under features?
  • Apply and mention conventions based on vue-style-guide (for base components, naming, etc)

Related PR: #1363 (not fully covering this issue atm)

Copy link
Member

atinux commented Feb 12, 2021

Agree on it.

[q] Where to put advanced docs about extending components with hooks (module authors) and diagram? We may add it under features?

I think it could be directly into "Configuration Glossary > components".

Renaming "Features > Nuxt Components" to "Features > Components" (or built-in components?)

Features > Built-in Components

@pi0
Copy link
Member Author

pi0 commented Feb 12, 2021

I think it could be directly into "Configuration Glossary > components

Hmm but i'm afraid other hooks aren't in configuration docs. This section would be also extended probably for including tips for unit test setup and internals

Features > Built-in Components

Seems good 👍

Copy link
Member

atinux commented Feb 12, 2021

Hmm but i'm afraid other hooks aren't in configuration docs. This section would be also extended probably for including tips for unit test setup and internals

Indeed, listing hooks are tricky, see https://nuxtjs.org/docs/2.x/configuration-glossary/configuration-hooks#list-of-hooks

All the hooks lives in Internal Glossary, I don't know what would be the best place for Components hooks actually 😅

@pi0
Copy link
Member Author

pi0 commented Feb 13, 2021

I would go with a try with internals then :)

@atinux atinux self-assigned this Feb 22, 2021
@alexchopin alexchopin self-assigned this Feb 22, 2021
@pi0 pi0 changed the title Single place for components discovery docs Component discovery docs May 13, 2021
Copy link
Member

atinux commented Jul 12, 2021

It's now document here: https://preview.nuxtjs.org/docs/features/component-discovery

I am wondering that we should change the order for the Features group

@atinux atinux closed this as completed Jul 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants