Add docc on a github page (#54)

* 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

* fix links to SPI

* add generated doc to github pages

* change doc base directory path

* add a nojekyll file for github page

* link to github page instead of SPI

* add public Makefile

* dynamcly add the swift docc plugin to generate the doc

* update doc

* ignore docs folder in soundness check

* add more license ignore files

* add doc github action

* fix yaml

* delete docs dir from repo - generate it dynamically instead

Author: sebsto

.github/workflows/doc.yml

@@ -0,0 +1,40 @@
+name: DocC Runner
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# A single job that builds and deploys the DocC documentation
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build DocC
+        run: |
+          make generate-doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: 'docs'
+      - id: deployment
+        name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.gitignore

@@ -12,10 +12,8 @@ Package.resolved
 .serverless
 .vscode
 .env
-Makefile
 **/temp
 node_modules
-docc-output
 
 # **/backend
 **/backend/.DS_Store

.licenseignore

@@ -38,4 +38,8 @@ Package.resolved
 **/*.code-snippets
 .DS_Store
 .licenseignore
-**/*.entitlements
+**/*.entitlements
+.nojekyll
+docs/**
+.unacceptablelanguageignore
+Makefile

.nojekyll

@@ -0,0 +1 @@
+docs/

.unacceptablelanguageignore

@@ -0,0 +1,32 @@
+# Makefile for library
+
+format:
+	swift format format --parallel --recursive --in-place ./Package.swift Examples/ Sources/ Tests/
+
+preview-docs:
+# 	xcrun docc preview Sources/BedrockService/Docs.docc --output-path docc-output
+	swift package --disable-sandbox preview-documentation --target BedrockService
+
+# https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/
+generate-docs:
+	# Dynamically add the swift-docc-plugin for doc generation
+	cp Package.swift Package.swift.bak
+	for manifest in Package.swift Package@*.swift ; do \
+		if [[ -f "$$manifest" ]] && ! grep -E -i "https://github.com/(apple|swiftlang)/swift-docc-plugin" "$$manifest" ; then \
+			echo "package.dependencies.append(" >> "$$manifest" ; \
+			echo "	.package(url: \"https://github.com/swiftlang/swift-docc-plugin\", from: \"1.4.5\")" >> "$$manifest" ; \
+			echo ")" >> "$$manifest" ; \
+		fi ; \
+	done
+
+	touch .nojekyll
+	swift package                         \
+		--allow-writing-to-directory ./docs \
+		generate-documentation              \
+		--target BedrockService             \
+		--disable-indexing                  \
+		--transform-for-static-hosting      \
+		--hosting-base-path swift-bedrock-library \
+		--output-path ./docs
+	
+	mv Package.swift.bak Package.swift

Makefile

@@ -15,7 +15,6 @@ let package = Package(
         .package(url: "https://github.com/smithy-lang/smithy-swift", from: "0.158.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.6.4"),
         .package(url: "https://github.com/awslabs/aws-crt-swift", from: "0.53.0"),
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [
         .target(

Package.swift

@@ -2,7 +2,7 @@
 
 A Swift library for interacting with [Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html) foundation models.
 
-📖 **[Complete Documentation](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation)** - Comprehensive guides and API reference
+📖 **[Complete Documentation](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/)** - Comprehensive guides and API reference
 
 ## TL;DR - Quick Start
 
@@ -27,7 +27,7 @@ Add to your `Package.swift`:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/build-on-aws/swift-bedrock-library.git", branch: "main")
+    .package(url: "https://github.com/build-on-aws/swift-bedrock-library.git", from: "1.5.0")
 ],
 targets: [
     .target(
@@ -43,14 +43,14 @@ Requires: `platforms: [.macOS(.v15), .iOS(.v18), .tvOS(.v18)]`
 
 ## Documentation
 
-📖 **[Complete Documentation](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation)** - Comprehensive guides and API reference
+📖 **[Complete Documentation](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/)** - Comprehensive guides and API reference
 
 Key topics:
-- [Authentication](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation/bedrockservice/authentication) - Configure AWS credentials
-- [Converse API](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation/bedrockservice/converse) - Conversational AI
-- [Image Generation](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation/bedrockservice/imagegeneration) - Create and modify images
-- [Tools](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation/bedrockservice/tools) - Function calling
-- [Streaming](https://swiftpackageindex.com/build-on-aws/swift-bedrock-library/documentation/bedrockservice/streaming) - Real-time responses
+- [Authentication](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/authentication) - Configure AWS credentials
+- [Converse API](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/converse) - Conversational AI
+- [Image Generation](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/imagegeneration) - Create and modify images
+- [Tools](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/tools) - Function calling
+- [Streaming](https://build-on-aws.github.io/swift-bedrock-library/documentation/bedrockservice/streaming) - Real-time responses
 
 ## Examples