Docs Minor updates (#290)

## Fixes

- Typos
- Bad links
- Wording

Author: wilwade

docs/src/Actions/Response.md

@@ -28,9 +28,9 @@ Response Sections
 
 ### `userPublicKey`
 
-The public key for the user identifies the user for this session.
-If that user has a Frequency blockchain account (MSA), the MSA Id can be retrieved from Frequency using this key.
-Or in the case when it does not, the `payloads` section will contain the payload to create said MSA Id.
+The user for the current session is identified via the public key.
+If the user has a Frequency blockchain account (MSA), the user’s MSA Id can be retrieved from Frequency via this key.
+If the user does not have an account, the payloads section with contain the payload to create the MSA Id.
 
 While the `userPublicKey` may change, the MSA Id will _always_ be the same for the same user account.
 
@@ -48,7 +48,7 @@ These credentials follow the [DSNP Verifiable Credentials Specification](https:/
 
 _Trust Model Note_: You may choose to just trust credentials issued by Frequency Access (or other SIWF-compatible services) given that the credential is fetched directly. These will have issuer `did:web:testnet.frequencyaccess.com` or `did:web:frequencyaccess.com`.
 
-1. Check that the `credentialSubject.id` matches the `userPublicKey` following the [`did:key` Method from the W3C](https://w3c-ccg.github.io/did-method-key/#format)
+1. Check that the `credentialSubject.id` matches the `userPublicKey` following the [`did:key` Method from the W3C](https://w3c-ccg.github.io/did-key-spec/#format)
   - Example: `f6cL4wq1HUNx11TcvdABNf9UNXXoyH47mVUwT59tzSFRW8yDH` is the [SS58](https://docs.substrate.io/reference/address-formats/) version with prefix `90` of the hex address `0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d`. `0xef01d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d` is multicodec `sr25519-pub` hex which is multiformat `base58-btc` `z6QNzHod3tSSJbwo4e5xGDcnsndsR9WByZzPoCGdbv3sv1jJ`
 2. Fetch the issuer DID Document following the [`did:web` Method from the W3C](https://w3c-ccg.github.io/did-method-web/)
   - Production-Mainnet should always be `did:web:frequencyaccess.com` which resolves to `https://frequencyaccess.com/.well-known/did.json`
@@ -84,7 +84,7 @@ The payloads that require submission to Frequency should be submitted in one bat
 The `addProvider` *must* always be *first* in the batch to ensure the correct permissions and delegations are in place for subsequent actions in the batch.
 
 Signatures to Frequency have an expiration set to a future Frequency block number.
-If the actions are not submitted before expriation, Frequency will reject the transactions and your application will need to request new signatures.
+If the actions are not submitted before expiration, Frequency will reject the transactions and your application will need to request new signatures.
 
 [Payload Examples and Signature Details](../Payloads.md)
 
@@ -108,7 +108,7 @@ Chain ID: frequency:{{chainReference}}
 Issued At: {{issued-at}}
 ```
 
-Inside the message, `{{domain}}` is the domain of the application requesting the sign-in. `{{domain}}` should match the domain contained in the `URI` field.
+Inside the message, `{{domain}}` is the domain of the application requesting the sign in. `{{domain}}` should match the domain contained in the `URI` field.
 
 #### Validation Steps
 
@@ -166,7 +166,7 @@ Frequency submission is required for any of the following payloads:
 
 They can be submitted to the chain in one transaction using [`pay_with_capacity_batch_all`](https://frequency-chain.github.io/frequency/pallet_frequency_tx_payment/index.html#extrinsics).
 
-## Step 6: Session Starts
+## Step 7: Session Starts
 
 Once the payloads have been validated, the user's authenticated session may start.
 SIWF services do not manage user sessions.

docs/src/Actions/flow.puml

@@ -16,14 +16,14 @@ alt Application Backend resolves payload
     ua->p: GET against callback url with authoricationCode
     p->fa: GET /<API_BASE>/api/payload trade authorizationCode for SiwfPayloadResponse
     return SiwfPayloadResponse {signed payloads and credentials}
-    p->ua: Post sign-in screen
+    p->ua: Post sign in screen
     p->bc: If needed, submit required transactions to Frequency
     return Transaction result
 else User Agent resolves payload
     ua->ua: Pre-empted by OS (Universal Link)
     ua->fa: GET /<API_BASE>/api/payload trade authorizationCode for SiwfPayloadResponse
     return SiwfPayloadResponse {signed payloads and credentials}
-    ua->ua: Post sign-in screen
+    ua->ua: Post sign in screen
     ua->p: Sign in result
     p->bc: If needed, submit required transactions to Frequency
     return Transaction result

docs/src/Actions/flow.svg

@@ -2,7 +2,7 @@
 
 ## Schema
 
-An application context credential MUST be a W3C Verifiable Credential document containing information about the application requesting user sign-in.
+An application context credential MUST be a W3C Verifiable Credential document containing information about the application requesting user sign in.
 
 The `type` array for the credential should begin with the string `"ApplicationContextCredential"`.
 

docs/src/DataStructures/ApplicationContext.md

@@ -3,7 +3,7 @@
 ## Quick Reference
 
 - [SIWF Android SDK Source Code + Demo App](https://github.com/ProjectLibertyLabs/siwf-sdk-android)
-- [Maven Central Package](https://central.sonatype.com/artifact/io.projectliberty/siwf) `implementation("io.projectliberty:siwf:1.0.0")`
+- [Maven Central Package `io.projectliberty:siwf`](https://central.sonatype.com/artifact/io.projectliberty/siwf)
 
 ## 1. Installation
 
@@ -20,7 +20,7 @@ dependencies {
 }
 ```
 
-[Maven Central Pacakge Page](https://central.sonatype.com/artifact/io.projectliberty/siwf)
+[Maven Central Package Page](https://central.sonatype.com/artifact/io.projectliberty/siwf)
 
 
 ## 2. Displaying the SIWF Button
@@ -37,9 +37,13 @@ Siwf.CreateSignInButton(
 )
 ```
 
+`authRequest` requires the [Signed Request Payload](../Actions/Start.html#step-1-generate-the-signed-request-payload) in either `base64url` encoded or structured form.
+
 ## 3. Handling Authorization Callbacks
 
-Update your `AndroidManifest.xml` with your own intent filters for authentication callbacks. Example:
+Update your `AndroidManifest.xml` with your own intent filters for authentication callbacks.
+Then, use a `BroadcastReceiver()` to receive the authorization code with `AuthConstants.AUTH_INTENT_KEY`.
+Example:
 
 ```xml
 <activity
@@ -62,12 +66,10 @@ Update your `AndroidManifest.xml` with your own intent filters for authenticatio
 </activity>
 ```
 
-Then, use a `BroadcastReceiver()` to receive the authorization code with `AuthConstants.AUTH_INTENT_KEY`.
-
 ## 4. Process Authorization Code
 
 On your backend service, process the authorization code and start your session.
 
 Resources:
-- [SIWF Documentation on Processing a Result](https://projectlibertylabs.github.io/siwf/v2/docs/Actions/Response.html)
+- [Documentation on Processing a Result](../Actions/Response.html)
 - [Frequency Gateway SSO Tutorial](https://projectlibertylabs.github.io/gateway/GettingStarted/SSO.html)

docs/src/SDK/Android.md

@@ -1,33 +1,32 @@
-# Sign-In With Frequency (SIWF) SDK Integration Guide
+# Sign In With Frequency (SIWF) SDK Integration Guide
 
 The SIWF SDK provides a seamless authentication experience for your applications.
 These guides will walk you through integrating the SIWF SDK into your **iOS** or **Android** app.
 
-### Platform Specific SDK Guides
+### Platform-Specific SDK Guides
 
-- [Android](/SDK/Android.md)
-- [iOS](/SDK/iOS.md)
+- [Android](Android.md)
+- [iOS](iOS.md)
 
 ---
 
 ## General Overview
 
 ### 1. Installation
 
-Add the platform specific package to your project.
+Add the platform-specific package to your project.
 
 ### 2. Displaying the SIWF Button
 
-The SIWF Button creation will require the [Signed Request Payload](/Actions/Start.html#step-1-generate-the-signed-request-payload) in either `base64url` encoded or structured form.
+SIWF Button creation will require the [Signed Request Payload](../Actions/Start.html#step-1-generate-the-signed-request-payload) in either `base64url` encoded or structured form.
 You may also specify other options such as the button style (light/dark) and the network (Mainnet/Testnet) to use.
 
 ### 3. Handling Authorization Callbacks
 
-You will need to create a redirect handler to receive the information from the Authorization.
-This is the redirect URL provided to the Signed Request Payload.
-That handler will receive the information Once the authorization is complete that can then be send and processed by your backend and initate the session.
+You will need to create a redirect handler to receive information from the Authorization (i.e. the redirect URL provided to the Signed Request Payload).
+This redirect handler will receive information once the authorization is complete, which may then be sent and processed by your system’s backend to initiate the session.
 
-See the platform specific details for how to create the callback handler.
+See platform-specific details in the [Android](Android.md) or [iOS](iOS.md) sections for instructions for creating the callback handler
 
 ### 4. Process Authorization Code
 

docs/src/SDK/Overview.md

@@ -3,7 +3,7 @@
 ## Quick Reference
 
 - [SIWF iOS SDK Source Code + Demo App](https://github.com/ProjectLibertyLabs/siwf-sdk-ios)
-- [Swift Package](https://swiftpackageindex.com/ProjectLibertyLabs/siwf-sdk-ios) `https://github.com/ProjectLibertyLabs/siwf-sdk-ios.git`
+- [Swift Package: `https://github.com/ProjectLibertyLabs/siwf-sdk-ios.git`](https://swiftpackageindex.com/ProjectLibertyLabs/siwf-sdk-ios)
 
 ## 1. Installation
 
@@ -33,14 +33,16 @@ import Siwf
 Siwf.createSignInButton(mode: .primary, authRequest: authRequest)
 ```
 
+`authRequest` requires the [Signed Request Payload](../Actions/Start.html#step-1-generate-the-signed-request-payload) in either `base64url` encoded or structured form.
+
 ## 3. Handling Authorization Callbacks
 
-Use `onOpenURL` and `Siwf.handleRedirectUrl` to handle deep links and retreive the authentication code.
+Use `onOpenURL` and `Siwf.handleRedirectUrl` to handle deep links and retrieve the authentication code.
 
 ## 4. Process Authorization Code
 
 On your backend service, process the authorization code and start your session.
 
 Resources:
-- [SIWF Documentation on Processing a Result](https://projectlibertylabs.github.io/siwf/v2/docs/Actions/Response.html)
+- [Documentation on Processing a Result](../Actions/Response.html)
 - [Frequency Gateway SSO Tutorial](https://projectlibertylabs.github.io/gateway/GettingStarted/SSO.html)

docs/src/SDK/iOS.md

@@ -4,7 +4,7 @@
     <!-- Index Site for SIWF that provides a basic index of pages -->
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Sign-In With Frequency (SIWF)</title>
+    <title>Sign In With Frequency (SIWF)</title>
     <style>
       body {
         font-family: Arial, sans-serif;
@@ -30,7 +30,7 @@
     </style>
   </head>
   <body>
-    <h1>Sign-In With Frequency (SIWF)</h1>
+    <h1>Sign In With Frequency (SIWF)</h1>
 
     <h2>SIWF v2</h2>
     <ul>
@@ -42,15 +42,11 @@ <h2>SIWF v1</h2>
     <ul>
       <li>
         v1 URL:
-        <a href="https://projectlibertylabs.github.io/siwf/v1/ui/"
-          >https://projectlibertylabs.github.io/siwf/v1/ui/</a
-        >
+        <a href="https://projectlibertylabs.github.io/siwf/v1/ui/">https://projectlibertylabs.github.io/siwf/v1/ui/</a>
       </li>
       <li><a href="/siwf/v1/example/">Example Site</a></li>
       <li>
-        <a href="https://github.com/ProjectLibertyLabs/siwf/tree/v1"
-          >Documentation</a
-        >
+        <a href="https://github.com/ProjectLibertyLabs/siwf/tree/v1">Documentation</a>
       </li>
     </ul>
   </body>