Skip to content

fix: update repository README #205

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

Merged
merged 2 commits into from
Jul 17, 2020
Merged

fix: update repository README #205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
639814a
feat: update repository README
NataliaTepluhina Jul 17, 2020
447424a
fix: added suggestion to disclaimer
NataliaTepluhina Jul 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# vuejs.org next
# v3.vuejs.org

This repo contains the code for the future VuePress version of the vuejs.org docs. A continuously deployed live preview is available at https://vue-docs-next-preview.netlify.com/.
This site is built with [VuePress](https://vuepress.vuejs.org/). Site content is written in Markdown format located in `src`.

## Getting Setup
## Writing

See the [Vue Docs Writing Guide](https://v3.vuejs.org/guide/writing-guide.html) for our rules and recommendations on writing and maintaining documentation.

> The docs are in beta: The team is currently in the midst of changes and we are not ready for additional contributions yet. All content is subject to change. If you see a problem that you would like to bring to our attention, please [create an issue](https://github.com/vuejs/docs-next/issues/new) and we will get to it when we can. You may want to wait until the content is finalized, though.

## Developing

1. Clone repository

Expand All @@ -21,3 +27,7 @@ yarn # or npm install
```bash
yarn serve
```

## Deploying

The site is automatically deployed when commits land in `master`, via [Netlify](https://www.netlify.com/).