Docs Roadmap

These are the documentation sections I want to add or improve

• Migrate to Vue.js theme
  • Use a neutral font (#873)
  • Adapt instructions for Vue 2.7
• Cookbook
  • Testing
    • Initializing the store before
    • What is needed for Nuxt (maybe link to another page) (#910)
    • Document action usage within setup stores cannot be stubbed https://github.com/vuejs/pinia/issues/2291
  • Advanced reactivity
    • Show how to use composables inside option and setup stores
  • Spltting the store into multiple files (#802)
  • Allowing making a Store implement an interface (state, actions, or/and getters)
  • Advanced SSR
    • Hydrating differing state like useLocalStorage()
    • Differences between Setup and Option stores
    • Using stores before hydration https://github.com/vuejs/pinia/discussions/948
  • Handling Errors with API calls
  • CDN installation for Vue 2 and Vue 3 #1051
• State must be defined as a whole #1335
• Setup Stores (https://github.com/vuejs/pinia/issues/978)
  • Currently only Option stores are documented properly. It would be nice to have a switch somewhere or to mention them early on and link to a cookbook entry about advanced reactivity as these stores allow patterns that are impossible (or not intuitive) to achieve with the options API, like watching
• Being able to switch between syntaxes (option / setup store) (TBD if worth) https://github.com/vuejs/pinia/issues/1265
• Reorganize the What is Pinia and Getting Started sections so the latter shows complete examples (#1195)
• Add note about patch modifying in place objects #1921

If you have suggestions about common use cases that are not covered or improvement / refactoring for the existing docs, please share

How to contribute

If you want to contribute to the docs, make sure first there is no active Pull Request or an existing branch on this repository. Fork this repo, and create a Pull Request. You can mark it as WIP/Not ready for review if you need more time to work on it. This would avoid having two people working on the same thing.

If you are uncertain about anything you wrote, just leave a review on your own Pull Request so I can help.

Translations

If you want to contribute translations, only the Chinese and English versions are hosted within the repository. Other translations should be hosted elsewhere following the translation guidelines