Skip to content

Commit ebba805

Browse files
committed
chore: update readme
1 parent d11f79d commit ebba805

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

actions/submit-docs/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,22 @@ jobs:
3232
owner: dfinity
3333
repo: icp-js-sdk-docs
3434

35-
# Build your docs and commit them to the `icp-pages` branch.
36-
# Use the assemble-docs action for convenience.
35+
# Build your docs and put them in the `docs/dist` folder.
36+
37+
- name: Checkout icp-pages branch
38+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
39+
with:
40+
ref: icp-pages
41+
path: icp-pages
42+
43+
- name: Assemble docs
44+
uses: dfinity/ci-tools/actions/assemble-docs@luca/assemble-docs-action
45+
with:
46+
docs_output_dir: docs/dist # must be the same the folder where the static docs assets are written after build
47+
docs_version: v1
48+
docs_version_label: 'Version 1'
49+
latest_version_label: 'latest (v1)'
50+
icp_pages_dir: icp-pages # must be the same as the `path` in the checkout step
3751

3852
- name: Submit Documentation
3953
uses: dfinity/ci-tools/actions/submit-docs@main

0 commit comments

Comments
 (0)