Documentation update (#17)

This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
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 #17.
This commit is contained in:
2026-03-24 01:54:43 +00:00
committed by Javier Cicchelli
parent b14a9fa816
commit eaee2b84f0
12656 changed files with 12970 additions and 12928 deletions
@@ -1 +1 @@
{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"platforms":["macOS"]}]}],"abstract":[{"text":"Live Server","type":"text"}],"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"title":"Type Methods","anchor":"Type-Methods","generated":true}],"metadata":{"symbolKind":"enum","roleHeading":"Enumeration","externalID":"s:14DiscogsService7ServersO7Server1O","modules":[{"name":"DiscogsService"}],"title":"Servers.Server1","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"navigatorTitle":[{"text":"Server1","kind":"identifier"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"references":{"doc://DiscogsService/documentation/DiscogsService/Servers":{"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"navigatorTitle":[{"text":"Servers","kind":"identifier"}],"kind":"symbol","type":"topic","title":"Servers","url":"\/documentation\/discogsservice\/servers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Live Server"}],"kind":"symbol","type":"topic","title":"url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"abstract":[{"type":"text","text":"Live Server"}],"navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","type":"topic","title":"Servers.Server1","url":"\/documentation\/discogsservice\/servers\/server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"}}}
{"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"anchor":"Type-Methods","generated":true,"title":"Type Methods"}],"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"roleHeading":"Enumeration","role":"symbol","title":"Servers.Server1","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","externalID":"s:14DiscogsService7ServersO7Server1O","navigatorTitle":[{"text":"Server1","kind":"identifier"}]},"abstract":[{"type":"text","text":"Live Server"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"references":{"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}],"navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Live Server"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","url":"\/documentation\/discogsservice\/servers\/server1","title":"Servers.Server1"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Server URLs defined in the OpenAPI document.","type":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","title":"Servers","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Live Server"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()","title":"url()"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]}}}