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

docs(tasks): use server/ dir #2775

Draft
wants to merge 1 commit into
base: v2
Choose a base branch
from

Conversation

geromegrignon
Copy link
Contributor

@geromegrignon geromegrignon commented Oct 3, 2024

πŸ”— Linked issue

❓ 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

The current Tasks documentation includes a specific Nuxt note requiring the tasks folder to be in the server one (https://nitro.unjs.io/guide/tasks#define-tasks).
However, it's also required for a standalone Nitro application in its current state, making this note outdated and needing to update all path mentions to include server.

πŸ“ Checklist

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

@geromegrignon geromegrignon requested a review from pi0 as a code owner October 3, 2024 23:27
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

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

Thanks! (i think there are other places we have to update with server/ prefix) -- because in starter template we default srcDir to server

@geromegrignon
Copy link
Contributor Author

@pi0 I will add new commits to update the whole documentation.

@pi0 pi0 changed the title docs(tasks): server is the default tasks folder docs(tasks): use server/ dir Oct 4, 2024
@pi0
Copy link
Member

pi0 commented Oct 4, 2024

Thanks dear @geromegrignon it would be of great help for docs consistency! Would you like me to wait to push on same PR?

@geromegrignon geromegrignon marked this pull request as draft October 4, 2024 13:15
@geromegrignon
Copy link
Contributor Author

@pi0 sure, I converted it to draft meanwhile.

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

Successfully merging this pull request may close these issues.

2 participants