Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs(components): Add info about extensions and pathPrefix keys #8930

Closed
wants to merge 3 commits into from
Closed

docs(components): Add info about extensions and pathPrefix keys #8930

wants to merge 3 commits into from

Conversation

MorevM
Copy link
Contributor

@MorevM MorevM commented Nov 12, 2022

πŸ”— Linked issue

nuxt/nuxt#15447 (closed but there were a comments with explanations)

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Documentation for extensions and pathPrefix keys of components > dirs objects of nuxt.config.ts

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@codesandbox
Copy link

codesandbox bot commented Nov 12, 2022

CodeSandbox logoCodeSandbox logoΒ  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@netlify
Copy link

netlify bot commented Nov 12, 2022

βœ… Deploy Preview for nuxt3-docs ready!

Name Link
πŸ”¨ Latest commit 3ba7ff2
πŸ” Latest deploy log https://app.netlify.com/sites/nuxt3-docs/deploys/636f7ed3fe555e00086fd8ce
😎 Deploy Preview https://deploy-preview-8930--nuxt3-docs.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@MorevM
Copy link
Contributor Author

MorevM commented Nov 12, 2022

@danielroe I wrote a docs as promised in nuxt/nuxt#15447

Spelling corrections are welcome, also I'm not sure should I use object form of components key in docs or not?

// This one
components: [
  { path: '...' },
],

// or this one
components: {
  dirs: [
    { path: '...' },
  ]
}

Occurred since was editing via Github interface
});
```

This registers the components using the same strategy as used in Nuxt 2.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should explain this more clearly cause not every Nuxt 3 devs have used Nuxt 2.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is explained well in a paragraph before code block.
The reason I mention Nuxt 2 is this comment (and some next ones).

If developer used Nuxt2 then he will understand, and if he didn't then he has nothing to compare with anyway.
Perhaps this mention is simply redudant, especially if there is a focus on new members of the community.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is explained well in a paragraph before code block. The reason I mention Nuxt 2 is this comment (and some next ones).

If developer used Nuxt2 then he will understand, and if he didn't then he has nothing to compare with anyway. Perhaps this mention is simply redudant, especially if there is a focus on new members of the community.

I understand your reason, but imo we should explain it since maybe it's the feature that someone have been looking for. Maybe at least an example t ocompar the difference between pathPrefix: false and pathPrefix: true?

@danielroe danielroe added the documentation Improvements or additions to documentation label Nov 15, 2022
@danielroe
Copy link
Member

merged in 28a2a91.

@danielroe danielroe closed this Jan 19, 2023
@MorevM MorevM deleted the patch-2 branch January 19, 2023 15:17
@danielroe danielroe added the 3.x label Jan 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
3.x documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants