docs: jazzy broke so now we will use docc (#118)

.github/workflows/releaseDocumentation.yml

@@ -5,15 +5,21 @@ on:
   push:
     tags:
       - "*"
+  workflow_dispatch:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
-  docs:
+  build-docs:
     name: build documentation and release
-    runs-on: macos-latest
+    runs-on: macos-13
     env:
       GITHUB_ACTOR: ${{ github.actor }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -31,27 +37,26 @@ jobs:
       - name: Adding Known Hosts
         run: ssh-keyscan -H github.com >> ~/.ssh/known_hosts
 
-      - uses: ruby/setup-ruby@v1
+      - name: Build Docs
+        uses: nick-fields/retry@v2
         with:
-          ruby-version: 3.0
-          bundler-cache: true
-
-      - name: Install Jazzy
-        run: sudo gem install jazzy
+          max_attempts: 6
+          retry_on: error
+          timeout_minutes: 50
+        run: xcodebuild docbuild -scheme AtalaPrismSDK -destination "platform=macOS" -derivedDataPath ./doccBuild OTHER_DOCC_FLAGS="--transform-for-static-hosting --output-path ./docc --hosting-base-path '/atalaprismsdk'"
 
-      - name: ABC Install
-        uses: lyricwulf/abc@v1
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
         with:
-          macos: sourcekitten
+          path: ./docc
 
-      - name: Build Docs
-        run: ./.scripts/buildDocs.sh
-
-      - name: Push
-        uses: s0/git-publish-subdir-action@develop
-        env:
-          REPO: self
-          BRANCH: gh-pages # The branch name where you want to push the assets
-          FOLDER: docs # The directory where your assets are generated
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token
-          MESSAGE: "feat(docs): ({sha}) {msg}" # The commit message
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build-docs
+
+    steps:
+    - name: Deploy Docs
+      uses: actions/deploy-pages@v1

AtalaPrismSDK/Apollo/Sources/Apollo.docc/Apollo.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/Apollo/ApolloHeader.md

@@ -1,4 +1,4 @@
-# ``Apollo``
+# Apollo
 
 Apollo is a suite of cryptographic primitives designed to ensure the integrity, authenticity, and confidentiality of any data that is stored and processed. These primitives provide a provably secure way to protect sensitive information, and they can be used in a wide range of applications.
 
@@ -33,3 +33,13 @@ Message Authentication Codes are a type of symmetric equivalent of digital signa
 Key exchange protocols enable two or more parties to securely negotiate a symmetric key, even if they only know each other’s public keys. Key exchange protocols are used to establish secure communication channels.
 
 By using the Apollo suite of cryptographic primitives, developers can build secure and provably secure applications that protect sensitive data from unauthorized access, tampering, or theft.
+
+## Topics
+
+### Tutorials
+
+- <doc:ApolloTutorials>
+
+### Errors
+
+- <doc:ApolloErrors>

AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/AtalaPrismSDK.md

@@ -12,20 +12,19 @@ Atala PRISM is a self-sovereign identity (SSI) platform and service suite for ve
 
 Atala PRISM Swift SDK provides the following building blocks to create, manage and resolve decentralized identifiers, issue, manage and verify verifiable credentials, establish and manage trusted, peer-to-peer connections and interactions between DIDs, and store, manage, and recover verifiable data linked to DIDs.
 
-- __Apollo__: Building block that provides a suite of cryptographic operations.
-- __Castor__: Building block that provides a suite of DID operations in a user-controlled manner.
+- __<doc:ApolloHeader>__: Building block that provides a suite of cryptographic operations.
+- __<doc:CastorHeader>__: Building block that provides a suite of DID operations in a user-controlled manner.
 - __Pollux__: Building block that provides a suite of credential operations in a privacy-preserving manner.
-- __Mercury__: Building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner.
-- __Pluto__: Building block that provides an interface for storage operations in a portable, storage-agnostic manner.
-- __PrismAgent__: PrismAgent using all the building blocks provides an agent that can offer a set of high level DID functionalities.
+- __<doc:MercuryHeader>__: Building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner.
+- __<doc:PlutoHeader>__: Building block that provides an interface for storage operations in a portable, storage-agnostic manner.
+- __<doc:PrismAgentHeader>__: PrismAgent using all the building blocks provides an agent that can offer a set of high level DID functionalities.
 
 ## Documentation
 
 ### General information and articles
 
 - [Getting Started](https://docs.atalaprism.io/docs/getting-started)
-- [What is identity?](https://docs.atalaprism.io/docs/concepts/what-is-identity)
-- [Digital wallets](https://docs.atalaprism.io/docs/concepts/digital-wallets)
+- [What is identity?](https://docs.atalaprism.io/docs/concepts/identity)
 - [Atala PRISM Overview](https://docs.atalaprism.io/docs/atala-prism/overview)
 
 ### Architecture decision articles

AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/BuildingBlocks.md

@@ -8,14 +8,14 @@ Each building block serves a specific purpose, and together they provide a solid
 
 Let's take a closer look at each building block:
 
-- [Apollo](apollo.html): Apollo is a building block that provides a suite of cryptographic operations. This includes secure hash algorithms, digital signatures, and encryption, which are all essential for creating a secure and tamper-proof identity system. Apollo ensures that all data within the Atala PRISM system is securely encrypted and digitally signed, making it resistant to tampering and unauthorized access.
-- [Castor](castor.html): Castor is a building block that provides a suite of decentralized identifier (DID) operations in a user-controlled manner. DIDs are a key component of decentralized identity, as they provide a way to uniquely identify individuals and entities in a decentralized manner. Castor allows users to create, manage, and control their DIDs and associated cryptographic keys.
-- [Pollux](pollux.html): Pollux is a building block that provides a suite of credential operations in a privacy-preserving manner. Credentials are a way to prove claims about an individual or entity, and they are an important part of decentralized identity. Pollux allows users to create, manage, and share credentials in a privacy-preserving way to ensure that sensitive information is not revealed.
-- [Mercury](mercury.html): Mercury is a building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner. Mercury allows different components of Atala PRISM to communicate with each other securely, using standard protocols such as HTTP, WebSocket, and MQTT.
-- [Pluto](pluto.html): Pluto is a building block that provides an interface for storage operations in a portable, storage-agnostic manner. Pluto allows data to be stored and retrieved in a way that is independent of the underlying storage technology, allowing Atala PRISM to work with a variety of storage solutions.
+- <doc:ApolloHeader>: Apollo is a building block that provides a suite of cryptographic operations. This includes secure hash algorithms, digital signatures, and encryption, which are all essential for creating a secure and tamper-proof identity system. Apollo ensures that all data within the Atala PRISM system is securely encrypted and digitally signed, making it resistant to tampering and unauthorized access.
+- <doc:CastorHeader>: Castor is a building block that provides a suite of decentralized identifier (DID) operations in a user-controlled manner. DIDs are a key component of decentralized identity, as they provide a way to uniquely identify individuals and entities in a decentralized manner. Castor allows users to create, manage, and control their DIDs and associated cryptographic keys.
+- Pollux: Pollux is a building block that provides a suite of credential operations in a privacy-preserving manner. Credentials are a way to prove claims about an individual or entity, and they are an important part of decentralized identity. Pollux allows users to create, manage, and share credentials in a privacy-preserving way to ensure that sensitive information is not revealed.
+- <doc:MercuryHeader>: Mercury is a building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner. Mercury allows different components of Atala PRISM to communicate with each other securely, using standard protocols such as HTTP, WebSocket, and MQTT.
+- <doc:PlutoHeader>: Pluto is a building block that provides an interface for storage operations in a portable, storage-agnostic manner. Pluto allows data to be stored and retrieved in a way that is independent of the underlying storage technology, allowing Atala PRISM to work with a variety of storage solutions.
 
 Together, these building blocks provide a solid foundation for building decentralized identity applications that are secure, privacy-preserving, and interoperable. By using Atala PRISM, developers can focus on building innovative identity solutions without having to worry about the underlying infrastructure.
 
 ## Prism Agent
 
-Prism Agent is a comprehensive library that brings together all the building blocks of the Prism platform - Apollo, Castor, Pluto, Mercury, and Pollux - to provide a seamless experience for developers working with decentralized identifiers (DIDs) on the Prism platform.
+<doc:PrismAgentHeader> is a comprehensive library that brings together all the building blocks of the Prism platform - Apollo, Castor, Pluto, Mercury, and Pollux - to provide a seamless experience for developers working with decentralized identifiers (DIDs) on the Prism platform.

AtalaPrismSDK/Castor/Sources/Castor.docc/Castor.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/Castor/CastorHeader.md

@@ -1,4 +1,4 @@
-# ``Castor``
+# Castor
 
 Castor is a powerful and flexible library for working with DIDs. Whether you are building a decentralized application or a more traditional system that requires secure and private identity management, Castor provides the tools and features you need to create, manage, and resolve DIDs with ease.
 
@@ -11,3 +11,9 @@ Decentralized Identifiers (DIDs) are a new type of identifier that allows indivi
 Castor supports the creation and resolution of two types of DIDs out of the box: prism and peer.
 
 With Castor, developers can create and manage DIDs, generate and manage their associated public and private keys, and resolve DIDs to retrieve associated data. Castor also provides a range of advanced features, such as support for multiple key types and encryption methods, and a flexible API for customizing and extending its functionality.
+
+## Topics
+
+### Tutorials
+
+- <doc:CastorTutorials>

AtalaPrismSDK/Mercury/Sources/Mercury.docc/Mercury.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/Mercury/MercuryHeader.md

@@ -1,4 +1,4 @@
-# ``Mercury``
+# Mercury
 
 Mercury is a powerful and flexible library for working with decentralized identifiers and secure communications protocols. Whether you are a developer looking to build a secure and private messaging app, or you are building a more complex decentralized system that requires trusted peer-to-peer connections, Mercury provides the tools and features you need to establish, manage, and secure your communications with ease.
 
@@ -14,6 +14,6 @@ Mercury also provides a range of advanced features, including support for messag
 
 ## Topics
 
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
+### Tutorials
 
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
+- <doc:MercuryTutorials>

AtalaPrismSDK/Mercury/Sources/Mercury.docc/MercuryTutorials.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/Mercury/MercuryTutorials.md

@@ -1,4 +1,4 @@
-# Mercury SDK API Tutorial
+# Mercury API Tutorial
 
 The Mercury protocol defines a set of functions for packing and sending messages. Here's a brief explanation of each function:
 

AtalaPrismSDK/Pluto/Sources/Pluto.docc/Pluto.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/Pluto/PlutoHeader.md

@@ -1,4 +1,4 @@
-# ``Pluto``
+# Pluto
 
 Pluto is a powerful and flexible data storage interface library for working with decentralized identifiers. Whether you are building a decentralized application that requires secure and private data storage, or you are working with a more traditional system that requires reliable and redundant storage for your DID-related data, Pluto provides the tools and features you need to get the job done with ease.
 

AtalaPrismSDK/PrismAgent/Sources/PrismAgent.docc/PrismAgent.md → AtalaPrismSDK/AtalaPrismSDK/Sources/AtalaPrismSDK.docc/PrismAgent/PrismAgentHeader.md

@@ -1,4 +1,4 @@
-# ``PrismAgent``
+# PrismAgent
 
 Prism Agent is a powerful and flexible library for working with decentralized identifiers on the Prism platform. Whether you are building a decentralized application that requires secure and private identity management, or you are working with a more traditional system that requires reliable and resilient communication between DIDs, Prism Agent provides the tools and features you need to get the job done with ease.
 
@@ -14,6 +14,6 @@ Prism Agent also provides support for receiving messages through the mediator, a
 
 ## Topics
 
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
+### Tutorials
 
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
+- <doc:PrismAgentTutorials>

AtalaPrismSDK/AtalaPrismSDK/Sources/Docs.swift

@@ -1 +1,7 @@
-// Just a file that needs to exist so the package doesnt fail
+@_exported import Domain
+@_exported import PrismAgent
+@_exported import Apollo
+@_exported import Castor
+@_exported import Mercury
+@_exported import Pluto
+@_exported import Pollux

Package.swift

@@ -7,19 +7,6 @@ let package = Package(
     name: "AtalaPRISMSDK",
     platforms: [.iOS(.v15), .macOS(.v12)],
     products: [
-        .library(
-            name: "AtalaPrismSDK",
-            targets: [
-                "AtalaPrismSDK",
-                "Domain",
-                "Castor",
-                "Apollo",
-                "Mercury",
-                "Pluto",
-                "Pollux",
-                "PrismAgent"
-            ]
-        ),
         .library(
             name: "Domain",
             targets: ["Domain"]
@@ -55,6 +42,12 @@ let package = Package(
         .library(
             name: "Authenticate",
             targets: ["Authenticate"]
+        ),
+        .library(
+            name: "AtalaPrismSDK",
+            targets: [
+                "AtalaPrismSDK",
+            ]
         )
     ],
     dependencies: [