#2 Welcome page content repurposed to "What is PayID?" #126
Conversation
There was a problem hiding this comment.
This looks great @LoisRP. Left a few minor stylistic suggestions and some other minor things to follow up on.
| sidebar_label: Welcome to PayID | ||
| id: what-is-payid | ||
| title: What is PayID? | ||
| sidebar_label: What is PayID? |
There was a problem hiding this comment.
Out of scope of this PR but it would be great to tweak the text in this section to directly answer this question in the first sentence, e.g. "PayID is..." That will take a little more work, though.
|
|
||
| 1. Click **Get Payment Information** on the left. | ||
| 2. Enter the PayID. On the sandbox, you are restricted to PayIDs on your server. Enter the PayID you just created, or another one you happen to know. Select either **cURL** or **JavaScript** at the top right. | ||
| 3. Click **Run**. The JSON response provides information about the PayID. |
There was a problem hiding this comment.
Any reason not to include a sample response here as well?
There was a problem hiding this comment.
Now I see what you mean. Have added there as well.
| 1. Click **Get User** on the left. | ||
| 2. Enter the PayID you want to look up. | ||
| 3. Select either **cURL** or **JavaScript**. | ||
| 4. Click **Run**. The JSON response provides information about the PayID. |
There was a problem hiding this comment.
For all of these, I think it would be useful to provide an example of the response. In this case, it would be useful to see the successful return as well as the error case you note below.
| **Get Payment Information** is a public API, and does not require your Admin API token. You can use this API for any PayID. | ||
|
|
||
| 1. Click **Get Payment Information** on the left. | ||
| 2. Enter the PayID. On the sandbox, you are restricted to PayIDs on your server. Enter the PayID you just created, or another one you happen to know. Select either **cURL** or **JavaScript** at the top right. |
There was a problem hiding this comment.
Are there any well-known public servers we could point users to? (I'm guessing no.)
There was a problem hiding this comment.
You can't change the server in the UI. The sandbox only allows your specific local server.
docs/getting-started-sandbox.md
Outdated
| sidebar_label: Getting Started With PayID Sandbox | ||
| --- | ||
|
|
||
| With the [PayID Sandbox](https://payid.org/sandbox), you can experiment with PayID without deploying your own server. Although the PayID Sandbox can be used to create PayIDs, do not use these PayIDs that rely on this virtual server to send or receive real cryptocurrency. The PayID Sandbox does not directly support Verifiable PayID. |
There was a problem hiding this comment.
do not use these PayIDs that rely on this virtual server to send or receive real cryptocurrency.
This is probably worth a separate callout (a Caution, perhaps).
There was a problem hiding this comment.
Also suggest small tweak:
do not use PayIDs that rely on this virtual server to send or receive real cryptocurrency.
(remove "these")
| Requirements: | ||
|
|
||
| - GitHub account. You will use this GitHub account to log in to PayID Sandbox. | ||
| - Crypto addresses on other wallets or exchanges. You can map your PayID to these crypto addresses. |
There was a problem hiding this comment.
Not for this PR, but in the future would be great to see a link to another resource about wallets or how to generate the addresses.
docs/getting-started-sandbox.md
Outdated
| ## Open PayID Sandbox and Create a User | ||
|
|
||
| 1. Open [PayID Sandbox](https://payid.org/sandbox) and log in with your GitHub account. | ||
| The sandbox sets up a virtual server for you at _github_user_name_.sandbox.payid.org. |
There was a problem hiding this comment.
github_user_name.sandbox.payid.org
Trivial but consider placing all of the above in code format and making the variable obnoxiously obvious, i.e.:
<YOUR_GITHUB_USERNAME>.sandbox.payid.org
docs/getting-started-sandbox.md
Outdated
| 3. Select either **cURL** or **JavaScript**. | ||
| 4. Click **Run**. The JSON response provides information about the PayID. | ||
|
|
||
| If you enter a nonexistent PayID, you get the response "Failed to find the PayID <_value_>". |
There was a problem hiding this comment.
"Failed to find the PayID <value>"
Trivial again, but consider making this code font if it's part of the response. And if you capitalize the variable, you won't need to use the underscores, too.
Failed to find the PayID <NONEXISTENT_PAYID_VALUE>
There was a problem hiding this comment.
Added code font. Kept quotes, because they are part of the response.
|
@LoisRP |
High Level Overview of Change
Note: I meant this to be a draft pull request like #125)
I love the visual look and content of the new home page for docs.payid.org, but that update lost the welcome page information about PayID. I think we should still have that, and here is one option to do so, but other options welcome.
Note: This branch is based on the branch that updated the "Get Started" content.
Context of Change
Changed Welcome page to "What is PayID?" in case of confusion with the home page. But other suggestions are welcome.
Type of Change
Before / After
"What is PayID?" page added that has the content of the old "Welcome to PayID" page.
Test Plan
Built and viewed locally.
Future Tasks
Consider other options for including this content.