Skip to content

Commit 9c5ea24

Browse files
fix: update repository README (#205)
* feat: update repository README * fix: added suggestion to disclaimer
1 parent e39702a commit 9c5ea24

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# vuejs.org next
1+
# v3.vuejs.org
22

3-
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/.
3+
This site is built with [VuePress](https://vuepress.vuejs.org/). Site content is written in Markdown format located in `src`.
44

5-
## Getting Setup
5+
## Writing
6+
7+
See the [Vue Docs Writing Guide](https://v3.vuejs.org/guide/writing-guide.html) for our rules and recommendations on writing and maintaining documentation.
8+
9+
> 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.
10+
11+
## Developing
612

713
1. Clone repository
814

@@ -21,3 +27,7 @@ yarn # or npm install
2127
```bash
2228
yarn serve
2329
```
30+
31+
## Deploying
32+
33+
The site is automatically deployed when commits land in `master`, via [Netlify](https://www.netlify.com/).

0 commit comments

Comments
 (0)