You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
-
# Ember JSON API Docs [](https://travis-ci.org/ember-learn/ember-jsonapi-docs)
1
+
# Ember JSON API Docs [](https://github.com/ember-learn/ember-jsonapi-docs/actions/workflows/ci.yaml)
2
2
3
-
This tool gets the code comments from `ember.js` and `ember-data` libraries,
3
+
4
+
This tool gets the code comments from `ember.js` and `ember-data` libraries,
4
5
turns them into JSON files, and then turns those JSON files into a
5
6
[JSON:API](http://jsonapi.org/) format.
6
7
@@ -13,7 +14,7 @@ The files this tool creates are used to power
13
14
## Prerequisites
14
15
15
16
- the latest [Node.js](https://nodejs.org/) LTS
16
-
-[yarn v1](https://yarnpkg.com/)
17
+
-[pnpm v9](https://pnpm.io/) (preferably managed via [corepack](https://github.com/nodejs/corepack))
17
18
18
19
Clone all of the following repositories into the same directory so they are "siblings" on the file system
19
20
@@ -45,8 +46,8 @@ files into the `s3-docs` directory of `ember-api-docs-data`:
45
46
46
47
```sh
47
48
cd ../ember-jsonapi-docs
48
-
yarn
49
-
yarn gen --project ember --version "5.2.0"
49
+
pnpm i
50
+
pnpm gen --project ember --version "5.2.0"
50
51
```
51
52
52
53
I would recommend committing in ember-api-docs-data at this stage so that you can see that the following steps work.
0 commit comments