[DOC] Create documentation from version 3.1.0 to 5.0.0

Author: JorgeCM

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,41 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-documentation:
+    name: Deploy documentation to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy-documentation.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Archive documentation
+        run: tar --directory docs -cvf docs.tar .
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: github-pages
+          path: docs.tar
+          retention-days: 1
+
+      - name: Deploy documentation
+        id: deploy-documentation
+        uses: actions/deploy-pages@v4

README.md

@@ -8,6 +8,10 @@ The ZendeskSDKConversationKit library is used to communicate with the Zendesk Su
 
 You can find our documentation on https://developer.zendesk.com/embeddables.
 
+## API reference documentation
+
+You can check the [API documentation](https://zendesk.github.io/sdk_conversation_kit_ios/) for Swift and Objective-C. In addition, a [DocCArchive](https://developer.apple.com/documentation/xcode/distributing-documentation-to-external-developers#Send-a-documentation-archive-directly-to-developers) is also attached to every GitHub release. Download the file, open it and Xcode will add it to the Imported Documentation section of the documentation viewer.
+
 ## Feature requests and issues
 
 All feature requests and issues are welcomed. Please see our [contributing guidelines](./CONTRIBUTING.md) to find out how to contact us.

docs/ZendeskSDKConversationKit/3.1.0/css/523.e9a069b0.css

@@ -0,0 +1 @@
+{"metadata":{"role":"symbol","roleHeading":"Enumeration","navigatorTitle":[{"kind":"identifier","text":"ActionItemSize"}],"externalID":"c:@M@ZendeskSDKConversationKit@E@ZDKMessageItemSize","modules":[{"name":"ZendeskSDKConversationKit"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"ActionItemSize","kind":"identifier"}],"symbolKind":"enum","title":"ActionItemSize"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize"},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.zendesk.ConversationKit\/Se","doc:\/\/com.zendesk.ConversationKit\/SE","doc:\/\/com.zendesk.ConversationKit\/SQ","doc:\/\/com.zendesk.ConversationKit\/SH","doc:\/\/com.zendesk.ConversationKit\/SY"],"title":"Conforms To","type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"attribute","text":"@objc"},{"kind":"text","text":"(ZDKMessageItemSize) "},{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ActionItemSize"}]}]}],"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/compact","doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/large","doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/none"]},{"title":"Initializers","identifiers":["doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/init(rawValue:)"]},{"identifiers":["doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/Equatable-Implementations","doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/RawRepresentable-Implementations"],"title":"Default Implementations","generated":true}],"abstract":[{"text":"The display size of ","type":"text"},{"code":"MessageActionItem","type":"codeVoice"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/zendesksdkconversationkit\/actionitemsize"]},{"traits":[{"interfaceLanguage":"occ"}],"paths":["\/documentation\/zendesksdkconversationkit\/actionitemsize"]}],"references":{"doc://com.zendesk.ConversationKit/SQ":{"identifier":"doc:\/\/com.zendesk.ConversationKit\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/init(rawValue:)":{"identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/init(rawValue:)","url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/init(rawvalue:)","role":"symbol","abstract":[],"type":"topic","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"title":"init(rawValue:)","kind":"symbol"},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/large":{"fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"large"}],"identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/large","title":"ActionItemSize.large","url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/large","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ZDKMessageItemSizeLarge"}],"abstract":[{"type":"text","text":"Images are meant to be displayed with a compact layout."}],"role":"symbol"},"doc://com.zendesk.ConversationKit/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.zendesk.ConversationKit\/Se","type":"unresolvable"},"doc://com.zendesk.ConversationKit/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/com.zendesk.ConversationKit\/SH","type":"unresolvable"},"doc://com.zendesk.ConversationKit/SE":{"title":"Swift.Encodable","identifier":"doc:\/\/com.zendesk.ConversationKit\/SE","type":"unresolvable"},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/Equatable-Implementations":{"identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/Equatable-Implementations","url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/equatable-implementations","role":"collectionGroup","abstract":[],"type":"topic","title":"Equatable Implementations","kind":"article"},"doc://com.zendesk.ConversationKit/SY":{"title":"Swift.RawRepresentable","identifier":"doc:\/\/com.zendesk.ConversationKit\/SY","type":"unresolvable"},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"ActionItemSize"}],"abstract":[{"text":"The display size of ","type":"text"},{"code":"MessageActionItem","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/zendesksdkconversationkit\/actionitemsize","identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize","kind":"symbol","role":"symbol","title":"ActionItemSize","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ActionItemSize"}]},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/RawRepresentable-Implementations":{"kind":"article","title":"RawRepresentable Implementations","role":"collectionGroup","url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/rawrepresentable-implementations","identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/RawRepresentable-Implementations","abstract":[],"type":"topic"},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit":{"kind":"symbol","url":"\/documentation\/zendesksdkconversationkit","type":"topic","identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit","title":"ZendeskSDKConversationKit","role":"collection","abstract":[]},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/compact":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"compact","kind":"identifier"}],"abstract":[{"type":"text","text":"Images are meant to be displayed with a large layout."}],"url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/compact","title":"ActionItemSize.compact","identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/compact","type":"topic","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ZDKMessageItemSizeCompact","kind":"identifier"}]},"doc://com.zendesk.ConversationKit/documentation/ZendeskSDKConversationKit/ActionItemSize/none":{"role":"symbol","title":"ActionItemSize.none","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"none"}],"type":"topic","kind":"symbol","url":"\/documentation\/zendesksdkconversationkit\/actionitemsize\/none","abstract":[{"text":"Images are meant to be displayed with no specified layout.","type":"text"}],"navigatorTitle":[{"text":"ZDKMessageItemSizeNone","kind":"identifier"}],"identifier":"doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/none"}},"variantOverrides":[{"patch":[{"op":"replace","path":"\/identifier\/interfaceLanguage","value":"occ"},{"value":"Enumeration","op":"replace","path":"\/metadata\/roleHeading"},{"op":"replace","value":"ZDKMessageItemSize","path":"\/metadata\/title"},{"value":"enum","op":"replace","path":"\/metadata\/symbolKind"},{"op":"replace","value":[{"text":"ZDKMessageItemSize","kind":"identifier"}],"path":"\/metadata\/fragments"},{"path":"\/metadata\/navigatorTitle","op":"replace","value":[{"kind":"identifier","text":"ZDKMessageItemSize"}]},{"op":"replace","value":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/compact","doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/large","doc:\/\/com.zendesk.ConversationKit\/documentation\/ZendeskSDKConversationKit\/ActionItemSize\/none"]}],"path":"\/topicSections"},{"value":null,"path":"\/relationshipsSections","op":"replace"},{"path":"\/seeAlsoSections","value":null,"op":"add"},{"op":"replace","path":"\/primaryContentSections\/0","value":{"kind":"declarations","declarations":[{"languages":["occ"],"platforms":["iOS"],"tokens":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ZDKMessageItemSize"},{"kind":"text","text":": "},{"text":"NSInteger","preciseIdentifier":"c:@T@NSInteger","kind":"typeIdentifier"},{"kind":"text","text":";"}]}]}},{"op":"replace","value":"ZDKMessageItemSizeLarge","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1large\/title"},{"op":"replace","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1large\/fragments","value":[{"text":"ZDKMessageItemSizeLarge","kind":"identifier"}]},{"op":"replace","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize\/title","value":"ZDKMessageItemSize"},{"path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize\/fragments","value":[{"kind":"identifier","text":"ZDKMessageItemSize"}],"op":"replace"},{"op":"replace","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1compact\/title","value":"ZDKMessageItemSizeCompact"},{"path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1compact\/fragments","value":[{"kind":"identifier","text":"ZDKMessageItemSizeCompact"}],"op":"replace"},{"value":"ZDKMessageItemSizeNone","op":"replace","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1none\/title"},{"op":"replace","path":"\/references\/doc:~1~1com.zendesk.ConversationKit~1documentation~1ZendeskSDKConversationKit~1ActionItemSize~1none\/fragments","value":[{"text":"ZDKMessageItemSizeNone","kind":"identifier"}]}],"traits":[{"interfaceLanguage":"occ"}]}]}