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

Cleanup README #135

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Cleanup README #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75ec35b
Cleanup README
jaredgalanis Nov 10, 2023
ff0be69
Merge branch 'master' into jaredgalanis-patch-2
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
20 changes: 3 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,21 +113,7 @@ Once that is all done, push it and open a PR 🎉
> ✅ **TIP:** If you are debugging failed builds, periodically discard the changes
made to `ember-api-docs-data`, since changes are made in-place.

## (Optional) View the generated docs in a web app
## (Optional) View the generated docs in the `ember-api-docs` frontend

The Prembered version of the ember-api-docs expects a folder in its root that links to the `ember-api-docs-data` folder, so all you need to do is create a symbolic link to ember-api-docs-data and you can see the app running locally.

Clone the [ember-api-docs](https://github.com/ember-learn/ember-api-docs)
repository, install dependencies, and start the front end in "local" mode:

```sh
git clone https://github.com/ember-learn/ember-api-docs
cd ember-api-docs
ln -s ../ember-api-docs-data # assuming it's checked out in the same folder
npm install
yarn start
```

> Note: at the time of writing this the ember-api-docs app needs to be on the `prember` branch but this will change very soon when we go live with it.

Visit the app in your browser at [http://localhost:4200](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).