rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

Some package and library documentation updates (#13)

Browse Source 
This PR contains the work done to:
* Updated the library *DocC* documentation catalog;
* Updated the library documentation for both *Xcode* and *GitHub Pages*;
* Added the Swift version and compatibility badges to the README file;
* Added the link to the *GitHub Pages* documentation in the *Swift Package Index* configuration.

Reviewed-on: #13
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #13.
This commit is contained in:
Javier Cicchelli
2025-09-12 00:51:06 +00:00
committed by Javier Cicchelli
parent 3d923982b1
commit bc0ae63719
138 changed files with 119 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/data/documentation/amiiboservice/gameseries/key.json
+1 -1
View File
@@ -1 +1 @@
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries\/key"},"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"A key."}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"metadata":{"role":"symbol","modules":[{"name":"AmiiboService"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:13AmiiboService10GameSeriesV3keySSvp","symbolKind":"property","roleHeading":"Instance Property","title":"key"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/gameseries\/key"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"abstract":[{"type":"text","text":"A model that represents a game series."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"GameSeries","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/gameseries","title":"GameSeries","navigatorTitle":[{"text":"GameSeries","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},"doc://AmiiboService/documentation/AmiiboService/GameSeries/key":{"url":"\/documentation\/amiiboservice\/gameseries\/key","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","abstract":[{"type":"text","text":"A key."}],"title":"key","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries\/key"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","role":"collection","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService"}}}
{"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries\/key","interfaceLanguage":"swift"},"abstract":[{"text":"A key.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}]}],"metadata":{"title":"key","role":"symbol","roleHeading":"Instance Property","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService10GameSeriesV3keySSvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"symbolKind":"property"},"variants":[{"paths":["\/documentation\/amiiboservice\/gameseries\/key"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://AmiiboService/documentation/AmiiboService/GameSeries/key":{"abstract":[{"text":"A key.","type":"text"}],"url":"\/documentation\/amiiboservice\/gameseries\/key","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries\/key","role":"symbol","title":"key","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://AmiiboService/documentation/AmiiboService":{"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"text":" backend service.","type":"text"}],"url":"\/documentation\/amiiboservice","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","role":"collection","title":"AmiiboService","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","kind":"symbol","role":"symbol","type":"topic","title":"GameSeries","url":"\/documentation\/amiiboservice\/gameseries","abstract":[{"type":"text","text":"A model that represents a game series."}],"navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"GameSeries","kind":"identifier"}]}}}