From f2e73b5b28edda93f54f4976d1f7c4fff8e364e3 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Thu, 2 Nov 2023 07:08:34 -0400 Subject: [PATCH] fix: update installation instructions - the old install instructions didn't mention the need for the data repo to be located within the ember-api-docs repo - they also switched the serve commands --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0b0121cf7..fdbbe091d 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,18 @@ https://github.com/ember-learn/ember-jsonapi-docs ## Previewing these docs in the front end If you want to see how these docs will look in the -front end app: +front end app, clone `ember-api-docs` and then clone `ember-api-docs-data` into the `ember-api-docs` directory as that is where `ember-api-docs` will search for the JSON files: ``` +git clone https://github.com/ember-learn/ember-api-docs +cd ember-api-docs +npm install +npm run start:local + git clone https://github.com/ember-learn/ember-api-docs-data cd ember-api-docs-data yarn install yarn serve - -cd .. -git clone https://github.com/ember-learn/ember-api-docs -cd ember-api-docs-data -yarn install -yarn start:local ``` The JSON files will be served at `http://localhost:5050` and the app can be viewed in the browser at [http://localhost:4200]().