Skip to content

Commit ed58f7a

Browse files
committed
Fix: docc url not correct
1 parent d97bf2e commit ed58f7a

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.github/workflows/CI.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ jobs:
5959
id-token: write
6060
environment:
6161
name: github-pages
62-
url: ${{ steps.deployment.outputs.page_url }}
62+
url: ${{ steps.deployment.outputs.page_url }}/documentation/githubrestapiswiftopenapi
6363
runs-on: ubuntu-latest
6464
steps:
6565
- name: Deploy to GitHub Pages

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
This Swift code generator is built upon the [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator) and leverages the OpenAPI description for GitHub's REST API. The goal is to automate the creation of Swift language bindings, providing developers with a seamless way to interact with GitHub's REST API.
88

99
## Usage
10-
- Get Users
10+
- To get started, check out the [documentation](https://wei18.github.io/github-rest-api-swift-openapi/documentation/githubrestapiswiftopenapi/)
11+
12+
- Or refer to example: Get Users.
1113
https://github.com/Wei18/github-rest-api-swift-openapi/blob/46bd7a951cd6a2bda9a9d26d843d55bb12f769c3/Tests/UsersTests/UsersTests.swift#L8-L15
1214

1315
## Installation

0 commit comments

Comments
 (0)