docs: Improve local dev setup process through readme and doc edits #3215
Conversation
Made some changes to the main README, localenv README, and Local Playground docs for better usability, less confusion, and stronger content.
github-actions
bot
added
type: localenv
✅ Deploy Preview for brilliant-pasca-3e80ec canceled.
|
Forgot to run prettier
|
For some reason the Netlify deploy preview link didn't post. Here it is: https://deploy-preview-3215--brilliant-pasca-3e80ec.netlify.app/ |
| Note that you have to go through an additional "login" step by providing you IPv4 address as tunnel password before being able to visit the consent screen for the outgoing payment grant request. You can find out your current IPv4 address by e.g. visiting https://loca.lt/mytunnelpassword (or https://www.whatismyip.com/). | ||
| | Label | Component | URL | | ||
| | ----- | --------------- | --------------------- | | ||
| | | Postgres Server | http://localhost:5432 | |
There was a problem hiding this comment.
Instead of leaving the label cell empty, I think we should add N/A or remove the column entirely
|
|
||
| #### With a chromium browser: | ||
| - Open `chrome://inspect` |
There was a problem hiding this comment.
Can you make this a numeric list?
| @@ -196,99 +177,53 @@ For debugging with VS Code, you can add this configuration to your `.vscode/laun | |||
|
|
|||
There was a problem hiding this comment.
I can't add a comment to the previous line (maybe because it's part of the code block) but can you capitalize Rafiki?
| @@ -37,7 +37,7 @@ This environment will set up a playground where you can use the Rafiki Admin API | |||
|
|
|||
There was a problem hiding this comment.
This comment is re: the line above it (line 36). Can you change "use the Rafiki Admin APIs" to "use the GraphQL Admin APIs" so there's no confusion between the APIs and the Rafiki Admin?
| @@ -37,7 +37,7 @@ This environment will set up a playground where you can use the Rafiki Admin API | |||
|
|
|||
| :::note | |||
|
|
|||
| The Mock ASE provided in this repository is intended solely for internal use and demonstration purposes. It is not designed to serve as a reference architecture. If you are looking for a reference implementation of an ASE, please refer to the Test Wallet. | |||
| The Mock ASE provided in this repository is intended solely for internal use and demonstration purposes. It is not designed to serve as a reference architecture. If you are looking for a reference implementation of an ASE, please refer to the [Test Wallet](https://wallet.interledger-test.dev/). | |||
There was a problem hiding this comment.
Use the LinkOut component, which we love so very much, on the Test Wallet link, please.
| @@ -238,10 +238,20 @@ The following are the most commonly used commands: | |||
| The Open Payments APIs can be interacted with using the [Bruno collection](https://github.com/interledger/rafiki/tree/main/bruno/collections/Rafiki) ([resource server endpoints](https://github.com/interledger/rafiki/tree/main/bruno/collections/Rafiki/Open%20Payments%20APIs) and [auth server endpoints](https://github.com/interledger/rafiki/tree/main/bruno/collections/Rafiki/Open%20Payments%20Auth%20APIs)). | |||
| To interact with the Open Payments APIs using Bruno, you must: | |||
|
|
|||
| 1. load the collection into Bruno by clicking "Open Collection" | |||
| 2. navigating to `/rafiki/bruno/collections/Rafiki` on your machine and clicking "Open" | |||
| 1. Load the collection into Bruno by selecting "Open Collection" | |||
There was a problem hiding this comment.
Do bold instead of quotes for Open Collection; add ending period.
| 1. load the collection into Bruno by clicking "Open Collection" | ||
| 2. navigating to `/rafiki/bruno/collections/Rafiki` on your machine and clicking "Open" | ||
| 1. Load the collection into Bruno by selecting "Open Collection" | ||
| 2. Navigate to `/rafiki/bruno/collections/Rafiki` on your machine and select "Open" |
There was a problem hiding this comment.
Do bold instead of quotes for "Open" and add ending period.
|
|
||
| If you receive the error below while running the Bruno collection, try switching from <LinkOut href='https://docs.usebruno.com/get-started/javascript-sandbox'>Safe Mode to Developer Mode</LinkOut> | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Add a wrap so the example error will wrap on screen:
```wrap
If that doesn't work, add a space:
``` wrap
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| The Examples folder in the Bruno collection includes an [Open Payments](https://github.com/interledger/rafiki/tree/main/bruno/collections/Rafiki/Examples/Open%20Payments) example that can be executed in the following sequence: |
There was a problem hiding this comment.
What are your thoughts on replacing this list with a sequence diagram?
| @@ -254,7 +264,7 @@ The Examples folder in the Bruno collection includes an [Open Payments](https:// | |||
|
|
|||
| :::note | |||
|
|
|||
| You have to go through an interaction flow by clicking on the `redirect` link in the grant request response. More information about the interaction flow can be found <LinkOut href ='https://openpayments.dev/introduction/grants/'>here</LinkOut>. | |||
| You have to go through an interaction flow by selecting the `redirect` link in the grant request response. More information about the interaction flow can be found <LinkOut href ='https://openpayments.dev/introduction/grants/'>here</LinkOut>. | |||
There was a problem hiding this comment.
Maybe "...in the grant request's response". Small thing. I'm not sure if that helps clarify anything.
This PR improves the Rafiki documentation by enhancing clarity, filling gaps in the setup process, linking related resources, and removing ambiguity and redundancy. Addresses issue #3034
localenvREADME updatesMain README updates
localenvpackage and linked directly to that READMELocal Playground docs update
localenvfor the package name, Local Playground otherwise)