framework icon indicating copy to clipboard operation
framework copied to clipboard

Documentation progress

Open pi0 opened this issue 3 years ago • 14 comments

(This list is WIP. Credits to @Atinux and @clemcode for preparation)

Docs

Completion overview

This section is used to track progress on the documentation. Feel free to edit if you complete a section.

Getting started

Category Title Status
Getting started Quick start OK
Getting started Tutorial OK
Migration Summary OK
Migration Bridge OK
Migration V3 OK

Guide

Category Title Status
Concepts What is Nuxt? Rework
Concepts Vue.js development OK
Concepts Rendering modes OK
Concepts Auto imports OK
Concepts Server engine OK
Concepts Typescript OK
Features Assets OK
Features Head Management Rework
Features Data Fetching Rework
Features State management Rework
Features Error handling OK
Features Plugins TODO
Features API Routes TODO
Features Runtime config OK
Features Theming TODO
Features Modules TODO
Going Further Tooling TODO
Going Further Testing In progress
Going Further Native ES Modules OK
Going Further Module creation OK
Deployment Guide TODO
Deployment Azure OK
Deployment Cloudflare OK
Deployment Firebase OK
Deployment Netlify OK
Deployment PM2 OK
Deployment Vercel OK
Deployment Presets OK

API Reference

Category Title Status
Composables useAsyncData OK
Composables useCookie OK
Composables useError TODO
Composables useFetch OK
Composables useHydration TODO
Composables useHead OK
Composables useNuxtApp OK
Composables useRequestHeaders TODO
Composables useRoute OK
Composables useRouter OK
Composables useRuntimeConfig OK
Composables useState OK
Components NuxtPage OK
Components NuxtLayout OK
Components NuxtLink Rework
Components NuxtErrorBoundary OK
Utils $fetch TODO
Utils abortNavigation OK
Utils addRouteMiddleware OK
Utils clearError TODO
Utils defineNuxtComponent OK
Utils defineNuxtRouteMiddleware OK
Utils definePageMeta OK
Utils navigateTo OK
Utils refreshNuxtData TODO
Utils throwError TODO
Directory Structure .nuxt To complete
Directory Structure .output To complete
Directory Structure assets OK
Directory Structure components OK
Directory Structure composables OK
Directory Structure layouts OK
Directory Structure middleware OK
Directory Structure node_modules OK
Directory Structure pages OK
Directory Structure plugins OK
Directory Structure public OK
Directory Structure server OK
Directory Structure .gitignore OK
Directory Structure app.vue OK
Directory Structure nuxt.config.ts OK
Directory Structure .nuxtignore OK
Directory Structure package.json OK
Directory Structure tsconfig.json OK
Server Api TODO
Server Middleware TODO
Server Deployment presets TODO
Advanced Nuxt Internals OK
Advanced Nuxt Kit OK
Advanced Lifecycle hooks OK

pi0 avatar Apr 05 '22 17:04 pi0

Composables: useMeta, got renamed

Intevel avatar Apr 05 '22 19:04 Intevel

I think useRuntimeConfig is missing in the API References.

mwohlan avatar Apr 11 '22 08:04 mwohlan

Added to the table, thanks @mwohlan

atinux avatar Apr 11 '22 13:04 atinux

hi,thanks nuxt team work, does the nuxt3 doc have nuxt lifecycle? i mean like nuxt2

this is clear for understanding the nuxt life cycle

baixiaoyu2997 avatar Apr 12 '22 08:04 baixiaoyu2997

Not yet but shall be documented indeed @baixiaoyu2997

atinux avatar Apr 12 '22 10:04 atinux

Hey everyone, I guess the current docs are also missing the static deployment?

marcelxpfeifer avatar Apr 14 '22 18:04 marcelxpfeifer

Hey everyone, I guess the current docs are also missing the static deployment

This feature is still work in progress. But for sure! We plan to add deployment guide for static and generic Node server.

pi0 avatar Apr 14 '22 18:04 pi0

Can deployment for Heroku be added to the table? I just deployed a nuxt 3 app on the platform and can contribute to the documentation for it.

rguttersohn avatar Aug 25 '22 15:08 rguttersohn

Add a note for experimental section to cover the bleeding edge features coming.

atinux avatar Sep 09 '22 09:09 atinux