-
-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Documentation progress #13653
Copy link
Copy link
Closed
Labels
Description
(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 | OK |
| Composables | useFetch | OK |
| Composables | useHydration | OK |
| Composables | useHead | OK |
| Composables | useNuxtApp | OK |
| Composables | useRequestHeaders | OK |
| 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 | OK |
| Utils | abortNavigation | OK |
| Utils | addRouteMiddleware | OK |
| Utils | clearError | OK |
| Utils | defineNuxtComponent | OK |
| Utils | defineNuxtRouteMiddleware | OK |
| Utils | definePageMeta | OK |
| Utils | navigateTo | OK |
| Utils | refreshNuxtData | OK |
| Utils | showError | OK |
| 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 |
Reactions are currently unavailable
Metadata
Metadata
Labels
Type
Projects
Status
Later