Javier Cicchelli
36eecc15fb
This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages. To provide further details about the work done: - [x] written the *Getting Started* article in the documentation catalog; - [x] written the *AmiiboService* article in the documentation catalog; - [x] updated the text of the `README` file; - [x] downgraded the Swift tool version in the `Package` file to v5.5; - [x] added the missing header file to the `Package` file; - [x] updated the `SwiftLibs` package dependency to its latest release; - [x] re-generated the documentation targeting Xcode and Github pages. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #15
1 line
3.1 KiB
JSON
1 line
3.1 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"responseCodeNotFound"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclienterror\/responsecodenotfound"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCodeNotFound","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The status code of the response was not received at all."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"responseCodeNotFound"}],"title":"AmiiboClientError.responseCodeNotFound","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:13AmiiboService0A11ClientErrorO20responseCodeNotFoundyA2CmF","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError/responseCodeNotFound":{"role":"symbol","title":"AmiiboClientError.responseCodeNotFound","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"responseCodeNotFound"}],"abstract":[{"type":"text","text":"The status code of the response was not received at all."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError\/responseCodeNotFound","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclienterror\/responsecodenotfound"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[{"type":"text","text":"Ready-to-use service that retrieves decoded entities from any of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" available endpoints."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClientError":{"role":"symbol","title":"AmiiboClientError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClientError"}],"abstract":[{"type":"text","text":"This error definitions represents any error happening while the client makes a request to the remote API and handles the respective response, excluding the decoding of the retrieved data into a particular model."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboClientError"}],"url":"\/documentation\/amiiboservice\/amiiboclienterror"},"https://www.amiiboapi.com":{"title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com","url":"https:\/\/www.amiiboapi.com"}}} |