Skip to content

docs: mention config file name before code block - #19634

Merged
danielroe merged 1 commit into
nuxt:mainfrom
jofftiquez:patch-1
Mar 13, 2023
Merged

docs: mention config file name before code block#19634
danielroe merged 1 commit into
nuxt:mainfrom
jofftiquez:patch-1

Conversation

@jofftiquez

Copy link
Copy Markdown
Contributor

Inspiration

I wasn't able to see the file name immediately in the code block example because it disappears whenever you're hovering in the code block which makes it confusing for beginners.

🔗 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

📝 Checklist

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

**Inspiration**

I wasn't able to see the file name immediately in the code block example because it disappears whenever you're hovering in the code block which makes it confusing for beginners.
@codesandbox

codesandbox Bot commented Mar 13, 2023

Copy link
Copy Markdown

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

@danielroe danielroe changed the title refactor(docs): make config file explicit docs: mention config file name before code block Mar 13, 2023
@danielroe
danielroe merged commit 31445c1 into nuxt:main Mar 13, 2023
@danielroe danielroe mentioned this pull request Mar 14, 2023
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