Improve documentation

README.md

@@ -51,7 +51,7 @@ Let's say you want to go fetch an instance of `Blade` with ID `1`.
 
 Normally, you'd write some code looking like this:
 ```swift
-let url = URL(string: "https://xcapi.com/blades")! // Someone should make this API…
+let url = URL(string: "https://xcapi.com/blades/1")! // Someone should make this API…
 
 var request = URLRequest(url: url)
 request.httpMethod = "GET"
@@ -107,7 +107,8 @@ let result = try? await Ether.request(route: Routes.locations,
                                       showAlertIfFailed: .ifUserHasntMuted)
 ```
 
-Enjoy!
+So there ya go! Not bad, huh? 😎
+See the [Getting Started](#getting-started) section above to review installation instructions.
 
 ## Documentation
 

Sources/Ether/Documentation.docc/Quick Overview.md

@@ -8,7 +8,7 @@ Let's say you want to go fetch an instance of `Blade` with ID `1`.
 
 Normally, you'd write some code looking like this:
 ```swift
-let url = URL(string: "https://xcapi.com/blades")! // Someone should make this API…
+let url = URL(string: "https://xcapi.com/blades/1")! // Someone should make this API…
 
 var request = URLRequest(url: url)
 request.httpMethod = "GET"
@@ -63,10 +63,10 @@ let result = try? await Ether.request(route: Routes.locations,
                                       usingEncoding: .gZip)
 ```
 
-Enjoy!
+So there ya go! Not bad, huh? 😎
 
-## Topics
-
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
-
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
+<!--## Topics-->
+<!---->
+<!--### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->-->
+<!---->
+<!--- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->-->

docs/data/documentation/ether/ether/domainheaders.json

@@ -1 +1 @@
-{"sections":[],"metadata":{"externalID":"s:5EtherAAV13domainHeadersSDySSSDyS2SGGvpZ","title":"domainHeaders","role":"symbol","modules":[{"name":"Ether"}],"roleHeading":"Type Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"domainHeaders"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV","text":"Ether"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:5EtherAAV7Headersa"},{"kind":"text","text":"]"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/Ether\/documentation\/Ether","doc:\/\/Ether\/documentation\/Ether\/Ether"]]},"abstract":[{"text":"Here, you can set custom headers for specific domains.","type":"text"},{"text":" ","type":"text"},{"text":"That way, you can stay authenticated by passing a session token, specific to a domain, so that it’s not leaked out to other domains you may access.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/ether\/ether\/domainheaders"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"domainHeaders","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Ether","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV"},{"kind":"text","text":"."},{"identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers","preciseIdentifier":"s:5EtherAAV7Headersa","text":"Headers","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","interfaceLanguage":"swift"},"references":{"doc://Ether/documentation/Ether/Ether":{"url":"\/documentation\/ether\/ether","navigatorTitle":[{"text":"Ether","kind":"identifier"}],"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The core of Ether. All the core functions and types are namespaced under this."}],"identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Ether"}],"title":"Ether"},"doc://Ether/documentation/Ether":{"kind":"symbol","abstract":[{"type":"text","text":"Welcome to easy, clean, Swifty networking!"}],"title":"Ether","identifier":"doc:\/\/Ether\/documentation\/Ether","url":"\/documentation\/ether","role":"collection","type":"topic"},"doc://Ether/documentation/Ether/Ether/domainHeaders":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"domainHeaders","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5EtherAAV","text":"Ether","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:5EtherAAV7Headersa"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","role":"symbol","abstract":[{"text":"Here, you can set custom headers for specific domains.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"That way, you can stay authenticated by passing a session token, specific to a domain, so that it’s not leaked out to other domains you may access."}],"url":"\/documentation\/ether\/ether\/domainheaders","kind":"symbol","title":"domainHeaders","type":"topic"},"doc://Ether/documentation/Ether/Ether/Headers":{"title":"Ether.Headers","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers","type":"topic","url":"\/documentation\/ether\/ether\/headers","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"abstract":[{"type":"text","text":"A dictionary of headers to apply to a "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":"."}],"kind":"symbol"}}}
+{"sections":[],"metadata":{"symbolKind":"property","title":"domainHeaders","modules":[{"name":"Ether"}],"roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"domainHeaders"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Ether","kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV"},{"kind":"text","text":"."},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV7Headersa"},{"kind":"text","text":"]"}],"role":"symbol","externalID":"s:5EtherAAV13domainHeadersSDySSSDyS2SGGvpZ"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"domainHeaders"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","text":"Ether","kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers","preciseIdentifier":"s:5EtherAAV7Headersa","text":"Headers"},{"kind":"text","text":"]"}]}]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","interfaceLanguage":"swift"},"abstract":[{"text":"Here, you can set custom headers for specific domains.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"That way, you can stay authenticated by passing a session token, specific to a domain, so that it’s not leaked out to other domains you may access."}],"variants":[{"paths":["\/documentation\/ether\/ether\/domainheaders"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/Ether\/documentation\/Ether","doc:\/\/Ether\/documentation\/Ether\/Ether"]]},"references":{"doc://Ether/documentation/Ether/Ether":{"url":"\/documentation\/ether\/ether","title":"Ether","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Ether","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"The core of Ether. All the core functions and types are namespaced under this."}],"type":"topic","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","navigatorTitle":[{"text":"Ether","kind":"identifier"}],"role":"symbol"},"doc://Ether/documentation/Ether":{"identifier":"doc:\/\/Ether\/documentation\/Ether","role":"collection","title":"Ether","kind":"symbol","url":"\/documentation\/ether","type":"topic","abstract":[{"type":"text","text":"Welcome to easy, clean, Swifty networking!"}]},"doc://Ether/documentation/Ether/Ether/domainHeaders":{"title":"domainHeaders","type":"topic","abstract":[{"type":"text","text":"Here, you can set custom headers for specific domains."},{"text":" ","type":"text"},{"type":"text","text":"That way, you can stay authenticated by passing a session token, specific to a domain, so that it’s not leaked out to other domains you may access."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"domainHeaders","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Ether","preciseIdentifier":"s:5EtherAAV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV7Headersa","text":"Headers"},{"text":"]","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","role":"symbol","url":"\/documentation\/ether\/ether\/domainheaders"},"doc://Ether/documentation/Ether/Ether/Headers":{"role":"symbol","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers","kind":"symbol","title":"Ether.Headers","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Headers"}],"abstract":[{"type":"text","text":"A dictionary of headers to apply to a "},{"code":"URLRequest","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/ether\/ether\/headers","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"type":"topic"}}}