Skip to content

Commit 94f307f

Browse files
authored
Merge pull request #22 from ember-learn/jaredgalanis-patch-2
Clean up readme
2 parents 2b1e4f8 + e8979b5 commit 94f307f

File tree

1 file changed

+3
-27
lines changed

1 file changed

+3
-27
lines changed

README.md

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,6 @@
11
# Ember API Docs Data
22

3-
![Sync with S3](https://github.com/ember-learn/ember-api-docs-data/workflows/Sync%20with%20S3/badge.svg)
3+
The content in this repository is generated via
4+
[ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs). To build new versions of the files for this repository follow the instructions in `ember-jsonapi-docs`'s [README](https://github.com/ember-learn/ember-jsonapi-docs).
45

5-
The content of this repository is synced to the `s3://api-docs.emberjs.com`
6-
S3 bucket via a [GitHub Action](./github/workflows/sync.yml). The data is
7-
consumed by the [API Docs Viewer](https://github.com/ember-learn/ember-api-docs).
8-
9-
These files are auto-generated via
10-
https://github.com/ember-learn/ember-jsonapi-docs
11-
12-
## Previewing these docs in the front end
13-
14-
If you want to see how these docs will look in the
15-
front end app:
16-
17-
```
18-
git clone https://github.com/ember-learn/ember-api-docs-data
19-
cd ember-api-docs-data
20-
yarn install
21-
yarn serve
22-
23-
cd ..
24-
git clone https://github.com/ember-learn/ember-api-docs
25-
cd ember-api-docs-data
26-
yarn install
27-
yarn start:local
28-
```
29-
30-
The JSON files will be served at `http://localhost:5050` and the app can be viewed in the browser at [http://localhost:4200]().
6+
That content is consumed by the [`ember-api-docs` frontend](https://github.com/ember-learn/ember-api-docs). If you want to see how this content will look in the `ember-api-docs` frontend in your local environment follow [these instructions](https://github.com/ember-learn/ember-api-docs).

0 commit comments

Comments
 (0)