Skip to content

Commit df8e7ab

Browse files
correct mkdir for html. Added html serve option for html sdk docs.
1 parent ed2a66b commit df8e7ab

File tree

4 files changed

+672
-38
lines changed

4 files changed

+672
-38
lines changed

.github/actions/build-sdk/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ runs:
2424
run: mkdir typescript
2525

2626
- name: make html folder
27-
working-directory: ./html
27+
working-directory: ./sdk
2828
shell: bash
2929
run: mkdir html
3030

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ This repository documents the Supplier API specification and provides an SDK wit
3939
- By default it will run `make config` when the container is first setup
4040
- The [SDK](sdk) folder is excluded from all pre reqs
4141
- DO NOT make manual changes to the [SDK](sdk), instead [build](#build) it
42+
- The SDK folder is excluded from git commits,
43+
and will be built as part of the CI/CD pipeline and released as a GitHub
44+
release.
4245

4346
## Build
4447

@@ -49,6 +52,20 @@ make clean
4952
make build
5053
```
5154

55+
This will generate:
56+
57+
- Python SDK
58+
- TypeScript SDK
59+
- HTML Docs
60+
61+
To view HTML docs:
62+
63+
```bash
64+
npm run serve-html-docs
65+
```
66+
67+
by default they will be available at [http://localhost:3050](http://localhost:3050)
68+
5269
Currently these are include in Git. TODO: gitignore these and have the build pipeline generate artifacts that can be downloaded from GitHub.
5370

5471
## Licence

0 commit comments

Comments
 (0)