Skip to content

docs: add v4 docs #1845

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 20 commits into from
Nov 2, 2020
Merged

docs: add v4 docs #1845

merged 20 commits into from
Nov 2, 2020

Conversation

kiaking
Copy link
Member

@kiaking kiaking commented Oct 12, 2020 •
edited
Loading

This PR adds docs for Vuex 4. It uses VitePress as a builder.

TODOS

  • Update existing code example to use new API such as createStore.
  • Add new APIs to the API Reference page.
  • Add Composition API page.
  • Add TypeScript page.
  • Add migration guide from Vuex 3.
  • Setup domain for the v4 docs and Netlify integration.

@kiaking kiaking added the documentation Improvements or additions to documentation label Oct 12, 2020
@kiaking kiaking self-assigned this Oct 12, 2020
@kiaking kiaking requested a review from cuebit October 21, 2020 09:45
@kiaking kiaking force-pushed the v4-docs branch 2 times, most recently from 6dc2372 to 4bc9015 Compare October 30, 2020 10:55
cuebit
cuebit approved these changes Nov 2, 2020
View reviewed changes
Copy link
Member

@cuebit cuebit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Includes minor changes to align with how Vue 3 docs articulates its Composition API.

@kiaking please glaze over the changes and let me know if all looks good?

@kiaking kiaking marked this pull request as ready for review November 2, 2020 05:24
@kiaking kiaking added the 4.x label Nov 2, 2020
kiaking and others added 20 commits November 2, 2020 14:34
@kiaking
docs: install VitePress
b6d81fc
@kiaking
docs: working on
74433a4
@kiaking
docs: working on
14e376e
@kiaking
docs: working on
cc98c63
@kiaking
docs: working on
22be307
@kiaking
docs: add composition api page
584d51e
@kiaking
docs: add typescript support page
d739df6
@kiaking
build: update vitepress
af42186
@kiaking
chore: remove docs for gitbook
8225110
@kiaking
docs: add migration guide
f3ce699
@yyx990803 @kiaking
docs: bump vitepress and vue deps
ac809c8
@cuebit @kiaking
docs: Composition API
644f644 
Simplify explanations relative to the code examples provided.
@cuebit @kiaking
docs: API Reference
f509e74 
Minor remedial tweaks for consistency.
@cuebit @kiaking
docs: Migration Guide
c677e55
@cuebit @kiaking
docs: tweak language used for consistency
73a2d00
@cuebit @kiaking
docs: TypeScript Support
b2721ac 
Unifies examples and descriptions between sections.
@cuebit @kiaking
docs: spelling!
defd3bb
@cuebit @kiaking
docs: invalid import reference
dcb22ed
@kiaking
docs: remove unused images
d0af2a6
@kiaking
chore: add docs link and licence info to the README
a1dacbc
@kiaking kiaking merged commit c51f55f into 4.0 Nov 2, 2020
@kiaking kiaking deleted the v4-docs branch November 2, 2020 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cuebit cuebit cuebit approved these changes

Assignees

@kiaking kiaking

Labels
4.x documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kiaking @cuebit @yyx990803