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: flatten top-level project in layers example #18967

Merged
merged 3 commits into from
Feb 14, 2023

Conversation

AloisSeckar
Copy link
Sponsor Contributor

πŸ”— Linked issue

#18954

❓ 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

As it shows up in the linked discussion, the current example for Nuxt layers may cause a bit confusion, because the prefix app/ used to identify "files in the root directory" may be understood as an actual sub-directory instead.

Simply omitting app/ in the code examples would make clear what are the docs talking about.

This is proably the only place in the docs, where such prefix is used, files are adressed as nuxt.config.ts and app.vue without anything else all around, so it will also normalize the usage.

πŸ“ Checklist

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

Remove `app/` prefix from code examples, as it may cause confusion about the actual location of the file.
@codesandbox
Copy link

codesandbox bot commented Feb 11, 2023

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

@AloisSeckar AloisSeckar changed the title greater clarity of layers example docs: greater clarity of layers example Feb 13, 2023
Co-authored-by: pooya parsa <pyapar@gmail.com>
@danielroe danielroe changed the title docs: greater clarity of layers example docs: flatten top-level project in layers example Feb 14, 2023
@danielroe danielroe added this pull request to the merge queue Feb 14, 2023
Merged via the queue into nuxt:main with commit 523b495 Feb 14, 2023
@danielroe danielroe mentioned this pull request Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants