Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up readme #22

Merged
merged 3 commits into from
Nov 17, 2023
Merged

Clean up readme #22

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b608b9
Clean up readme
jaredgalanis Nov 10, 2023
d93179b
Update README.md
jaredgalanis Nov 10, 2023
e8979b5
Update README.md
jaredgalanis Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 5 additions & 23 deletions README.md
View file
Open in desktop
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
jaredgalanis marked this conversation as resolved.
Show resolved Hide resolved
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-api-docs).