meeting notes

[huang-julien]

have a devtools integration with tabs

• nuxt-hydration
• accessibility
• best practices in general
  • CSP
  • about nuxt but we need one first within the nuxt docs
• lighthouse best practices
  • CSP
  • COOP
  • deprecated APIs
  • third-party cookies
• images
  • aspect ratio
  • sizes
• meta tags
• console logs/error etc...

Priority

• having and define nuxt best practices
  • in seperate tabs
  • seperate plugin etc...

actions: 20-03

show theses notes to the meetings
focus on the docs
security notes for nitro

[Baroshem]

So the idea is to first start with writing documentation for nuxt.com similar to https://nextjs.org/docs/app/building-your-application where we could show guides about Performance, Security, SEO, Accessibility, and possibly some more.

After we have that, we can start building the Hints module where we could highlight the issue (i.e. image element that does not have a performance format) and point to the documentation where user would be able to fix that based on the guide provided by Nuxt.

Unless we wan't to keep it separate for each module? Like SEO best practices in the Nuxt SEO, Security best practices in Nuxt Security and so on?

Also, how should we approach writing the actual docs for Nuxt.com? Should we create a PR already to the documentation repository or start with a Google Docs/Notion document first? :)

[huang-julien]

how should we approach writing the actual docs for Nuxt.com?

I was thinking about adding a Best practices section in the sidebar here. But the rest of the team need to be onboarded

I'm not that good at writing but we know many people can :) and you are good at this

SEO best practices in the Nuxt SEO, Security best practices in Nuxt Security and so on

That's something we should probably discuss with maintainers to know if they're willing to do it in their own module.
We also need to take into account that not everyone uses nuxt-seo, nuxt-security (and so on) and may want to handle theses matters themselves. And that @nuxt/hints aims to be the core module for best practices and issue finder.

Should we create a PR already to the documentation repository or start with a Google Docs/Notion document first

I think we can probably draft a PR 🤔 everyone on the team would probably want to add their opinions into it.

we can start building the Hints module where we could highlight the issue

I've already setup the devtools client within the repo. And start re-organizing it a bit to make it easier to work on for future additionnal features

After we have that, we can start building the Hints module where we could highlight the issue (i.e. image element that does not have a performance format) and point to the documentation where user would be able to fix that based on the guide provided by Nuxt.

Yes, i'll draw a quick wireframe later for the devtools integration. As we discussed about it, we should also have something for people who doesn't enable devtools 🤣 . And also have a visual notification from @nuxt/hints (devtools or something else)