From 639814aa003984b4b893275cfd98934f487329c2 Mon Sep 17 00:00:00 2001 From: NataliaTepluhina Date: Fri, 17 Jul 2020 07:01:23 +0300 Subject: [PATCH 1/2] feat: update repository README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e97d3a6923..cc85f9cd3c 100644 --- a/README.md +++ b/README.md @@ -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. + +> At this time, because the docs are in beta, the team is currently in the midst of changes and we are not ready for additional contributions yet. To bring your issue to the team's attention though, we would recommend [creating an issue](https://github.com/vuejs/docs-next/issues/new) and we'll get to it when we can. + +## Developing 1. Clone repository @@ -21,3 +27,9 @@ yarn # or npm install ```bash yarn serve ``` + +## Deploying + +The site is automatically deployed when commits land in `master`, via [Netlify](https://www.netlify.com/). + + From 447424a832a83ec496c2451c9a788a1b3e396952 Mon Sep 17 00:00:00 2001 From: NataliaTepluhina Date: Fri, 17 Jul 2020 17:23:11 +0300 Subject: [PATCH 2/2] fix: added suggestion to disclaimer --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index cc85f9cd3c..4605aa82d3 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This site is built with [VuePress](https://vuepress.vuejs.org/). Site content is See the [Vue Docs Writing Guide](https://v3.vuejs.org/guide/writing-guide.html) for our rules and recommendations on writing and maintaining documentation. -> At this time, because the docs are in beta, the team is currently in the midst of changes and we are not ready for additional contributions yet. To bring your issue to the team's attention though, we would recommend [creating an issue](https://github.com/vuejs/docs-next/issues/new) and we'll get to it when we can. +> 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 @@ -31,5 +31,3 @@ yarn serve ## Deploying The site is automatically deployed when commits land in `master`, via [Netlify](https://www.netlify.com/). - -