Skip to content

Commit 0ba3400

Browse files
committed
Update README
1 parent 1e30e97 commit 0ba3400

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@ Action that generates website docs for branches and tags using docgen
44

55
## Usage
66

7+
**Imporant:** this action requires the `docs/docs.json` file to be built **before** the action is run.
8+
79
How to use it in a workflow:
810

911
```yaml
10-
- name: Build and deploy documentation
11-
uses: dbots-pkg/action-docs@v1
12+
- run: npm run docs
13+
14+
- uses: dbots-pkg/action-docs@v1
1215
env:
1316
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1417
```

0 commit comments

Comments
 (0)