Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: mention <DevOnly> component in api section #26029

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Mar 18, 2024
Merged

docs: mention <DevOnly> component in api section #26029

merged 4 commits into from
Mar 18, 2024

Conversation

trdln
Copy link
Contributor

@trdln trdln commented Mar 1, 2024

🔗 Linked issue

No issue, just a minor addition to the documentation.

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 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)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Added information about <DevOnly> component in Api section of docs. Information about component was only in Guide section.

📝 Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@nuxt-studio Nuxt Studio
Copy link
Contributor

nuxt-studio bot commented Mar 1, 2024

✅ Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio ↗︎ View Live Preview c65b083

danielroe
danielroe reviewed Mar 2, 2024
View reviewed changes
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

Should we remove from https://nuxt.com/docs/guide/directory-structure/components#devonly-component and link to here instead?

@trdln
Copy link
Contributor Author

trdln commented Mar 3, 2024

Seems fine for me, at your discretion.

@danielroe
Copy link
Member

Then yes, let's do it.

@trdln
Copy link
Contributor Author

trdln commented Mar 5, 2024 •
edited
Loading

Should we remove <ClientOnly> and <NuxtClientFallback> components too from https://nuxt.com/docs/guide/directory-structure/components?

@danielroe
Copy link
Member

danielroe commented Mar 5, 2024 •
edited
Loading

That would make sense to me, as long as we have links and ensure the content is still present in the docs on the pages about those specific components. wdyt @atinux?

@atinux
Copy link
Member

atinux commented Mar 5, 2024

Good for me to move them to the API, I still believe that it is nice to have a small section in the components directory page to mention about those DevOnly and ClientOnly components and link to them on the API section

@danielroe danielroe merged commit ac54031 into nuxt:main Mar 18, 2024
@github-actions github-actions bot mentioned this pull request Mar 18, 2024
Merged
@BalaKadiyala BalaKadiyala mentioned this pull request Jun 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@trdln @danielroe @atinux