Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobSyndeo committed Feb 7, 2024
1 parent 963553f commit beb1222
Show file tree
Hide file tree
Showing 124 changed files with 138 additions and 131 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,11 @@ dependencies: [
.package(url: "https://github.com/JacobSyndeo/Ether.git", from: "1.0.0")
]
```

## Documentation

For more information, check out the [documentation](https://ether.jacobpritchett.app/documentation/ether)!

<!-- ## Demo
You can find a demo app in the `Demo` directory. -->

<!-- ## Examples
## Examples

Here are some examples of what Ether can do.

Expand Down Expand Up @@ -112,4 +107,17 @@ let result = try? await Ether.request(route: Routes.locations,
showAlertIfFailed: .ifUserHasntMuted)
```

Enjoy! -->
Enjoy!

## Documentation

For more information, check out the [documentation](https://ether.jacobpritchett.app/documentation/ether)!

## Support

If you're anything less than delighted, or have any ideas on how to improve Ether, be sure to [open an issue](https://github.com/JacobSyndeo/Ether/issues), and I'll be sure to address it!

## More

If you like Ether, be sure to check out my other projects:
-[GreenAlert](https://github.com/JacobSyndeo/GreenAlert), a really useful way to use `UIAlertController`, using extensions.
2 changes: 1 addition & 1 deletion Sources/Ether/Documentation.docc/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ What is Ether, and why should you use it?

## What is Ether?

Ether is a delightful and easy to understand networking library for Swift. It's designed to be lightweight, easy to use, and easy to understand.
Ether is a _delightful_ networking library for Swift. It's designed to be lightweight, easy to use, and easy to understand.

## Why another networking library?

Expand Down
3 changes: 1 addition & 2 deletions Sources/Ether/Response.swift
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ extension Ether {
public struct Response<T> where T: Decodable {
/// The response's data.
/// Contains either a `Decodable` instance, or raw data.
///
/// See also: Ether's Response Data type, ``Ether/Ether/Response/Data-swift.enum``, _not_ to be confused with `Foundation`'s `Data` type.
/// - SeeAlso: Ether's Response Data type, ``Ether/Ether/Response/Data-swift.enum``, _not_ to be confused with `Foundation`'s `Data` type.
public var data: Data<T>

// Keep this internal, since the syntax of "response.response" is really dumb and messy.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/documentation/ether.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/ether/ether.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/ether/ether/domainheaders.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"abstract":[{"type":"text","text":"Here, you can set custom headers for specific domains."},{"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"}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"domainHeaders"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"text":"Ether","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","preciseIdentifier":"s:5EtherAAV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:5EtherAAV7Headersa","kind":"typeIdentifier","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers"},{"kind":"text","text":"]"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/ether\/ether\/domainheaders"]}],"metadata":{"roleHeading":"Type Property","externalID":"s:5EtherAAV13domainHeadersSDySSSDyS2SGGvpZ","role":"symbol","symbolKind":"property","title":"domainHeaders","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"domainHeaders"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Ether","kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV7Headersa","text":"Headers"},{"text":"]","kind":"text"}],"modules":[{"name":"Ether"}]},"identifier":{"url":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/Ether\/documentation\/Ether","doc:\/\/Ether\/documentation\/Ether\/Ether"]]},"sections":[],"references":{"doc://Ether/documentation/Ether/Ether":{"identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether","navigatorTitle":[{"text":"Ether","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The core of Ether. All the core functions and types are namespaced under this."}],"title":"Ether","url":"\/documentation\/ether\/ether","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Ether","kind":"identifier"}]},"doc://Ether/documentation/Ether/Ether/domainHeaders":{"kind":"symbol","abstract":[{"type":"text","text":"Here, you can set custom headers for specific domains."},{"type":"text","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"}],"url":"\/documentation\/ether\/ether\/domainheaders","type":"topic","role":"symbol","title":"domainHeaders","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/domainHeaders","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"domainHeaders","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5EtherAAV","text":"Ether","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5EtherAAV7Headersa","text":"Headers"},{"text":"]","kind":"text"}]},"doc://Ether/documentation/Ether":{"type":"topic","identifier":"doc:\/\/Ether\/documentation\/Ether","abstract":[{"type":"text","text":"Welcome to easy, clean, Swifty networking!"}],"kind":"symbol","url":"\/documentation\/ether","role":"collection","title":"Ether"},"doc://Ether/documentation/Ether/Ether/Headers":{"url":"\/documentation\/ether\/ether\/headers","identifier":"doc:\/\/Ether\/documentation\/Ether\/Ether\/Headers","type":"topic","role":"symbol","abstract":[{"text":"A dictionary of headers to apply to a ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"type":"text","text":"."}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"title":"Ether.Headers","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]}}}
{"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"}}}
Loading

0 comments on commit beb1222

Please sign in to comment.