docs: server routes streaming, configuration access, query access, etc#4401
docs: server routes streaming, configuration access, query access, etc#4401
Conversation
✅ Deploy Preview for nuxt3-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hi @maciej-jezierski, FYI documentation neither uses semicolons, nor double quotes (for wrapping strings in JS/TS code snippets). It might have been the linter you're using that changed them all. Good to keep an eye on it for the future PRs. You have also got some async functions without an await keyword in the body - is it intentional or shall these be removed? |
|
Hi @DamianGlowala , thanks for review. Indeed I didn't notice I had prettier plugin enabled. All not necessary changes are rolled back now and rest of the code is conducted to this standard. I also removed not necessary async keyword (functions were copied from bigger project..) |
|
Looks great! I'll leave the technical review to people who know this stuff better :) My very last suggestion would be to make the code indentation the same across all of the code snippets (2 spaces). Some of these appear to have 4. |
|
Just by looking at this PR, I'd suggest an idea of standardising the casing for the section headlines across the whole documentation, as there's currently a healthy mix of both. Given the example of this section alone, we got both pascal case headlines and these which only begin with uppercase. 'Handling Requests with Body' next to 'Using a nested router' looks a bit odd. |
|
By looking at other places, you can remove the uppercase expect on the first word or acronyms. |
|
Good point DamianGlowala I think we can move them to usage examples: BTW this page is getting more like an API reference. We need to find a way to auto generate utils with each example to API section. |
|
Thanks for the PR @maciej-jezierski 👍🏼 |


🔗 Linked issue
nuxt/nuxt#13749
❓ Type of change
📚 Description
Resolves issue nuxt/nuxt#13749. Showcase of server routing usage:
📝 Checklist