Skip to content

Commit

Permalink
Clean up readme
Browse files Browse the repository at this point in the history
- Some things weren't accurate anymore, so this cleans that up
- There are too many places that describe how to spin up a local environment so this moves to pointing to the instructions in ember-jsonapi-docs
  • Loading branch information
jaredgalanis authored Nov 10, 2023
1 parent 2b1e4f8 commit 3b608b9
Showing 1 changed file with 5 additions and 23 deletions.
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,10 @@
![Sync with S3](https://github.com/ember-learn/ember-api-docs-data/workflows/Sync%20with%20S3/badge.svg)

The content of this repository is synced to the `s3://api-docs.emberjs.com`
S3 bucket via a [GitHub Action](./github/workflows/sync.yml). The data is
consumed by the [API Docs Viewer](https://github.com/ember-learn/ember-api-docs).
S3 bucket via a [GitHub Action](./github/workflows/sync.yml). That data is
consumed by the [ember-api-docs frontend](https://github.com/ember-learn/ember-api-docs).

These files are auto-generated via
https://github.com/ember-learn/ember-jsonapi-docs
The content in this repository is generated via
[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).

## Previewing these docs in the front end

If you want to see how these docs will look in the
front end app:

```
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]().
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-jsonapi-docs#optional-view-the-generated-docs-in-a-web-app).

0 comments on commit 3b608b9

Please sign in to comment.