GitHub Pages documentation support. (#5)

This PR contains the work done to:
* Update the `Library` article in the DocC documentation catalog in the project;
* Generate the DocC documentation of the library for GitHub Pages;
* Written the `README` file in the project.

Reviewed-on: #5
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 #5.
This commit is contained in:
2025-09-09 18:34:29 +00:00
committed by Javier Cicchelli
parent 37c0f3e322
commit 410a200661
277 changed files with 690 additions and 3 deletions
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1 @@
{"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","interfaceLanguage":"swift"},"abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"client"},{"kind":"text","text":": "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier","text":"AmiiboClient"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A representation of a client to use to interact with the endpoints."}]}],"name":"client"}]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]]},"metadata":{"modules":[{"name":"AmiiboService"}],"title":"init(_:)","symbolKind":"init","externalID":"s:13AmiiboServiceAAVyAbA0A6ClientOcfc","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0A6ClientO","kind":"typeIdentifier","text":"AmiiboClient"},{"kind":"text","text":")"}],"roleHeading":"Initializer"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboservice\/init(_:)"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"abstract":[{"text":"A concrete representation of the types of client that a ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true,"type":"reference"},{"text":" service can utilize.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"type":"topic","title":"AmiiboClient","url":"\/documentation\/amiiboservice\/amiiboclient","kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboservice","role":"symbol","type":"topic","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","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."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/init(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(_:)","abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"title":"init(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/init(_:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6ClientO","text":"AmiiboClient"},{"kind":"text","text":")"}]}}}