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":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice\/lastupdated\/timestamp"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated\/timestamp","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The date of the latest update of the remote API."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"title":"timestamp","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:13AmiiboService11LastUpdatedV9timestamp10Foundation4DateVvp","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated"]]},"references":{"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"},"doc://AmiiboService/documentation/AmiiboService/LastUpdated/timestamp":{"role":"symbol","title":"timestamp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"timestamp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"type":"text","text":"The date of the latest update of the remote API."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated\/timestamp","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/lastupdated\/timestamp"},"doc://AmiiboService/documentation/AmiiboService/LastUpdated":{"role":"symbol","title":"LastUpdated","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LastUpdated"}],"abstract":[{"type":"text","text":"This model represents the latest date when the remote API has been updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LastUpdated"}],"url":"\/documentation\/amiiboservice\/lastupdated"},"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"}}} |