Skip to content

Commit 698a7e0

Browse files
authored
Move the doc to Swift docc (#53)
* move doc to Swift Docc and keep README minimal * add doc in the header * move acknowledgment section down the page * fix ci * add test for embeddings
1 parent b3a7fb7 commit 698a7e0

File tree

118 files changed

+2068
-1198
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+2068
-1198
lines changed

.github/workflows/pull_request.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,17 @@ jobs:
4040
# libssl-dev which is not installed on swift:6.2-noble
4141
# Using swift:6.2-amazonlinux2 is not a solution
4242
# because the @checkout action doesn't works on ALI2 (requires Node.js 20)
43+
# will re-enable when Amazon Linux 2023 will be available
4344
api_breakage_check_enabled: false
4445
api_breakage_check_container_image: "swift:6.2-noble"
45-
docs_check_container_image: "swift:6.2-noble"
46+
47+
# disabled because images needs libssl-dev (which excludes swift:6.2-noble)
48+
# and Node 20+ (for the checkout action), whcih excludes Amazon Linux 2
49+
# will re-enable when Amazon Linux 2023 will be available
50+
docs_check_enabled: false
51+
docs_check_container_image: "swift:6.2-amazonlinux2"
52+
53+
format_check_enabled: true
4654
format_check_container_image: "swift:6.2-noble"
4755
yamllint_check_enabled: true
4856

@@ -83,7 +91,7 @@ jobs:
8391
# We pass the list of examples here, but we can't pass an array as argument
8492
# Instead, we pass a String with a valid JSON array.
8593
# The workaround is mentioned here https://github.com/orgs/community/discussions/11692
86-
examples: "[ 'api-key', 'converse', 'converse-stream', 'openai', 'text_chat' ]"
94+
examples: "[ 'api-key', 'converse', 'converse-stream', 'embeddings', 'openai', 'text_chat' ]"
8795

8896
swift-6-language-mode:
8997
name: Swift 6 Language Mode

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Package.resolved
1515
Makefile
1616
**/temp
1717
node_modules
18+
docc-output
1819

1920
# **/backend
2021
**/backend/.DS_Store

.spi.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets: [BedrockService]

Package.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ let package = Package(
1515
.package(url: "https://github.com/smithy-lang/smithy-swift", from: "0.158.0"),
1616
.package(url: "https://github.com/apple/swift-log.git", from: "1.6.4"),
1717
.package(url: "https://github.com/awslabs/aws-crt-swift", from: "0.53.0"),
18+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
1819
],
1920
targets: [
2021
.target(

0 commit comments

Comments
 (0)