Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pinia's "Getting started" page lacks a basic example. #1195

Closed
ffunenga opened this issue Apr 3, 2022 · 1 comment
Closed

Pinia's "Getting started" page lacks a basic example. #1195

ffunenga opened this issue Apr 3, 2022 · 1 comment

Comments

@ffunenga
Copy link

ffunenga commented Apr 3, 2022

Reproduction

https://pinia.vuejs.org/getting-started.html

Steps to reproduce the bug

  1. Go to the Getting started page
  2. Read the Installation section. Try to do what is described there. Check that the given information is incomplete.
  3. Read the What is a Store? section. Check terminology contradiction between "A Store (like Pinia) is..." and "Create a pinia (the root store)..." in the Installation section. The same thing appears to have three differnet names: a "store", a "pinia" and a "root store".
  4. Read the When should I use a Store section. Read general information given in this section.
  5. Reach the end of the page. No clear example was provided. Recheck the page again: no success. Look at left bar for a possible salvation: no success.

Expected behavior

The behavior I "expected" (in my opinion, which may be different from what is intended by Pinia's docs writer(s) ) was to read a documentation page that would enable a person with basic knowledge in Vue to carry out an introductory example of Pinia's usage.

Actual behavior

See the explanation given in the Installation section (emphasis added here):

Create a pinia (the root store) and pass it to the app:

import { createPinia } from 'pinia'
app.use(createPinia())

My (subjective) issues with this:

  • "Create a pinia (the root store) (...) [js code is shown]" Should I create a new file? Where?
  • "...and pass it to the app" What "the" app? Where does app come from?

Additional information

No response

@posva posva mentioned this issue Apr 7, 2022
20 tasks
@posva
Copy link
Member

posva commented Apr 7, 2022

Added to #829

@posva posva closed this as completed Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants