From 8021690d4f15a583f13a89db6f83549eadaa102a Mon Sep 17 00:00:00 2001 From: Thad Guidry Date: Tue, 29 Jun 2021 15:25:52 -0500 Subject: [PATCH] Update info on Docs README about Next version (#4024) * Update info on Docs README about Next version @wetneb Does this look OK? I just tested and seems that this is how we can actually work and see the "current" docs and we didn't really document this anywhere as far as I can tell. So this README section is a good place? * fix numbered list --- docs/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 470ead609..dff03a822 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,7 +26,14 @@ yarn yarn start ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +This command starts a local development server and opens up a browser window. Usually at the URL http://localhost:3000 +Most changes are reflected live without having to restart the server. + +### Next version of OpenRefine docs +If you wish to work on the next version of docs for OpenRefine (`master` branch) then you will need to: +1. Git checkout our `master` branch +2. Edit files under `docs/docs/` +3. Preview changes with the URL kept pointing to http://localhost:3000/next which will automatically show changes live with yarn after you save a file. ### Build