Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: structure and content update #2875

Merged
merged 93 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
93 commits
Select commit Hold shift + click to select a range
b62ff73
Updated docs structure
JoblersTune Aug 16, 2024
4a1e036
chore: removing all docs copy, ready for new contant
JoblersTune Aug 16, 2024
d92ab32
testing collab on sarah's branch (#2869)
melissahenderson Aug 19, 2024
6150300
docs: integrator-checklist-update
hajjimo Aug 19, 2024
7cb832a
docs: testing update (#2870)
brad-dow Aug 19, 2024
1fdc4dd
chore: formatting
JoblersTune Aug 20, 2024
01b319b
chore: formatting
JoblersTune Aug 20, 2024
7f6fbf9
chore: fixed .prettierignore file
JoblersTune Aug 20, 2024
a64b0ac
docs: Add submenus to Integration section (#2871)
hajjimo Aug 20, 2024
f500411
chore: updating .gitignore
JoblersTune Aug 20, 2024
3c2e5eb
docs: upload of doc set to prep for Rafiki ww
melissahenderson Aug 21, 2024
1300737
docs: fixing linkout issue
melissahenderson Aug 21, 2024
90f4137
docs: another linkout fix
melissahenderson Aug 21, 2024
7017633
docs: sigh
melissahenderson Aug 21, 2024
c31c3ce
resolve conflicts and attempt to remove generated files
huijing Aug 21, 2024
f3c643d
remove generated files from source
huijing Aug 21, 2024
c475a26
git ignore generated files
huijing Aug 21, 2024
9e8ce60
docs: Imported first batch of Rafiki
brad-dow Aug 21, 2024
218ac44
docs: test-update
hajjimo Aug 22, 2024
5629901
docs: mi-test-pr
hajjimo Aug 22, 2024
b414ec6
docs - second round of Rafiki imports into new project
brad-dow Aug 22, 2024
853e1fb
docs: mi/docs-update-batch1
hajjimo Aug 23, 2024
c393b66
docs: mi-docs-update
hajjimo Aug 23, 2024
2591fd9
docs: mi-docs-update
hajjimo Aug 23, 2024
5b2a27c
docs: mi/docs-update
hajjimo Aug 23, 2024
4732a38
docs: mi/docs-update
hajjimo Aug 23, 2024
db1426e
docs: telemetry update, added a few links
melissahenderson Aug 23, 2024
e726ae9
docs: mi/docs-update-second-batch
hajjimo Aug 23, 2024
d291994
docs: mi/docs-update
hajjimo Aug 23, 2024
6086361
docs: mi/docs-update
hajjimo Aug 23, 2024
1632cce
docs - added some internal links
brad-dow Aug 23, 2024
ec788e1
docs - fixed a link
brad-dow Aug 23, 2024
48cbd3d
docs: updated some links
melissahenderson Aug 23, 2024
87aa01e
docs: reorgs
melissahenderson Aug 27, 2024
9151cff
docs: fix broken links
melissahenderson Aug 27, 2024
3640336
docs: update byb exchange rates
melissahenderson Aug 27, 2024
9aa72bb
docs updating before you begin
brad-dow Aug 27, 2024
e301242
docs broken link fix
brad-dow Aug 27, 2024
8cf3ff2
docs: more updates
melissahenderson Aug 27, 2024
b357b15
docs: fixing broken links hopefully
melissahenderson Aug 27, 2024
6f35708
Update packages/documentation/src/content/docs/integration/deployment…
melissahenderson Aug 28, 2024
89bb3dc
Update packages/documentation/src/content/docs/integration/deployment…
melissahenderson Aug 28, 2024
c103c01
Update packages/documentation/src/content/docs/integration/deployment…
melissahenderson Aug 28, 2024
f3e3008
docs: mi/move-env-variables-partials
hajjimo Aug 28, 2024
e10ec25
docs: mi/update-env-variables
hajjimo Aug 28, 2024
68c4cd2
docs user guide updates
brad-dow Aug 28, 2024
04182be
Merge branch 'sj/docs-structure-update' of https://github.com/interle…
brad-dow Aug 28, 2024
8d86542
docs: idp and service updates
melissahenderson Aug 28, 2024
8cd920c
docs: fix link errors
melissahenderson Aug 28, 2024
6f57b38
docs: variables to service pages
melissahenderson Aug 28, 2024
3ea57a7
docs: breaking up pages
melissahenderson Aug 29, 2024
e0ec577
docs: fixing borked links obviously
melissahenderson Aug 29, 2024
2c25a1b
docs: pushing to see which links break
melissahenderson Sep 2, 2024
fd56e01
docs: fixing links
melissahenderson Sep 2, 2024
6f41c97
docs - adding glossary
brad-dow Sep 3, 2024
aee0487
docs: you know the drill
melissahenderson Sep 3, 2024
be89fd9
docs: fixing link
melissahenderson Sep 3, 2024
8cb5884
chore: formatting CodeBlock elements
JoblersTune Sep 4, 2024
5964353
chore: Badge component formatting
JoblersTune Sep 4, 2024
ced2f01
Docs - page updates
brad-dow Sep 4, 2024
36faaf2
docs: attempting to make things explode
melissahenderson Sep 5, 2024
4c86f92
docs: fixing links and running prettier
melissahenderson Sep 5, 2024
cf16d34
docs: trying to finish
melissahenderson Sep 5, 2024
08c8807
docs: silly linkout component
melissahenderson Sep 5, 2024
8c5cc00
docs: fix idp links
melissahenderson Sep 5, 2024
79883d7
docs: mi/manage-peering
hajjimo Sep 6, 2024
e4138fb
docs: mi/manage-peering
hajjimo Sep 6, 2024
fca2337
docs-updating manage liquidity
brad-dow Sep 6, 2024
54b9d79
docs: wallet and webhook updates
melissahenderson Sep 6, 2024
9a4025d
docs: mi/environment-variables-update
hajjimo Sep 7, 2024
08dc85c
docs: mi/nginx-docker-compose-update
hajjimo Sep 7, 2024
feb1f82
docs: mi/docker-compose-update
hajjimo Sep 7, 2024
686fb7f
docs: mi/webhook-event-types
hajjimo Sep 7, 2024
d393793
docs: edit to overview
melissahenderson Sep 7, 2024
89f08f2
docs: fix error
melissahenderson Sep 8, 2024
7e7fa67
chore: included generated api docs (#2943)
JoblersTune Sep 9, 2024
dc87622
Update packages/documentation/src/content/docs/overview/concepts/acco…
melissahenderson Sep 9, 2024
6d2abec
docs: accounting updates and t tables
melissahenderson Sep 9, 2024
703847c
docs: updating links outside of user docs
melissahenderson Sep 9, 2024
e6be98c
docs: updating Rafiki Admin guide
brad-dow Sep 9, 2024
96440a9
docs: minor updates to non-user docs
melissahenderson Sep 10, 2024
3336b2d
docs: mi/docs-update-091024
hajjimo Sep 10, 2024
4dab120
chore: wording update for outgoing auth token
JoblersTune Sep 10, 2024
82a29d9
feat: updated 404 page
JoblersTune Sep 10, 2024
6228aec
chore:updated with main
JoblersTune Sep 10, 2024
d39d184
chore: removed unused files
JoblersTune Sep 10, 2024
ef29d66
chore: removed unused files
JoblersTune Sep 10, 2024
6fe9648
chore:formatting
JoblersTune Sep 10, 2024
a743310
Update packages/documentation/src/content/docs/admin/admin-user-guide…
JoblersTune Sep 10, 2024
ed1b34c
chore: fixing broken links from the update with main
JoblersTune Sep 10, 2024
7ff9b68
docs: update Rafiki Admin guide
brad-dow Sep 10, 2024
d1db96d
docs: folder cleanup
brad-dow Sep 10, 2024
06d0a53
docs: cleaning up dupe admin auth info
melissahenderson Sep 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ build
**/styles/*.css
.docusaurus
.cache-loader
packages/documentation/src/content/docs/apis
packages/documentation/src/content/docs/apis/graphql/**
.astro
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,23 @@

## What is Rafiki?

Rafiki is open source software that provides an efficient solution for an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/) to enable Interledger functionality on its users' accounts.
Rafiki is open source software that provides an efficient solution for an [account servicing entity](https://rafiki.dev/resources/glossary#account-servicing-entity-ase) to enable Interledger functionality on its users' accounts.

This includes

- sending and receiving payments (via [SPSP](https://rafiki.dev/reference/glossary/#simple-payments-setup-protocol-spsp) and [Open Payments](https://rafiki.dev/concepts/open-payments/overview/))
- allowing third-party access to initiate payments and view transaction data (via [Open Payments](https://rafiki.dev/concepts/open-payments/overview/))
- sending and receiving payments (via [SPSP](https://rafiki.dev/resources/glossary#simple-payment-setup-protocol-spsp) and [Open Payments](https://rafiki.dev/overview/concepts/open-payments))
- allowing third-party access to initiate payments and view transaction data (via [Open Payments](https://rafiki.dev/overview/concepts/open-payments))

**❗ Rafiki is intended to be run by [Account Servicing Entities](https://rafiki.dev/reference/glossary/#account-servicing-entity) only and should not be used in production by non-regulated entities.**
**❗ Rafiki is intended to be run by account servicing entities only and should not be used in production by non-regulated entities.**

Rafiki is made up of several components, including an Interledger connector, a high-throughput accounting database called [TigerBeetle](https://rafiki.dev/concepts/accounting/tigerbeetle/), and several APIs:
Rafiki is made up of several components, including an Interledger connector, a high-throughput accounting database called [TigerBeetle](https://rafiki.dev/overview/concepts/accounting#tigerbeetle), and several APIs:

- the [Admin API](https://rafiki.dev/apis/backend/schema/) to create [peering relationships](https://rafiki.dev/concepts/interledger-protocol/peering/), add supported [assets](https://rafiki.dev/concepts/asset/), and issue [wallet addresses](https://rafiki.dev/reference/glossary/#wallet-address)
- the [Open Payments](https://rafiki.dev/reference/glossary/#open-payments) API to allow third parties (with the account holder's consent) to initiate payments and to view the transaction history
- the [SPSP](https://rafiki.dev/reference/glossary/#simple-payments-setup-protocol-spsp) API for simple Interledger Payments
- the [Admin APIs](https://rafiki.dev/apis/graphql/admin-api-overview) to create [peering relationships](https://rafiki.dev/overview/concepts/interledger#peers),
add supported [assets](https://rafiki.dev/overview/concepts/accounting#assets), and issue [wallet addresses](https://rafiki.dev/resources/glossary#wallet-address)
- the [Open Payments](https://rafiki.dev/overview/concepts/open-payments) API to allow third parties (with the account holder's consent) to initiate payments and to view the transaction history
- the [SPSP](https://rafiki.dev/resources/glossary#simple-payment-setup-protocol-spsp) API for simple Interledger Payments

Additionally, this package also includes a reference implementation of a [GNAP](https://rafiki.dev/reference/glossary/#grant-negotiation-authorization-protocol) authorization server, which handles the access control for the [Open Payments](https://rafiki.dev/reference/glossary/#open-payments) API. For more information on the architecture, check out the [Architecture documentation](https://rafiki.dev/introduction/architecture/).
Additionally, this package also includes a reference implementation of a [GNAP](https://rafiki.dev/resources/glossary#grant-negotiation-and-authorization-protocol-gnap) authorization server, which handles the access control for the Open Payment API. For more information on the architecture, check out the [Architecture documentation](https://rafiki.dev/resources/architecture).

### New to Interledger?

Expand All @@ -28,7 +29,7 @@ Never heard of Interledger before? Or would you like to learn more? Here are som
- [Interledger Website](https://interledger.org/)
- [Interledger Specs](https://interledger.org/rfcs/0027-interledger-protocol-4/)
- [Interledger Explainer Video](https://twitter.com/Interledger/status/1567916000074678272)
- [Open Payments](https://openpayments.guide/)
- [Open Payments](https://openpayments.dev/)
- [Web monetization](https://webmonetization.org/)

## Contributing
Expand Down
8 changes: 4 additions & 4 deletions localenv/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Local Playground

We have created a suite of packages that, together, mock an account servicing entity that has deployed Rafiki, exposing an [SPSP](https://rafiki.dev/reference/glossary/#simple-payments-setup-protocol-spsp) endpoint, the [Open Payments](https://rafiki.dev/concepts/open-payments/overview/) APIs with its required [GNAP](https://rafiki.dev/reference/glossary/#grant-negotiation-authorization-protocol) auth endpoints to request grants, a STREAM endpoint for receiving Interledger packets, and a UI to view and manage the Rafiki instance.
We have created a suite of packages that, together, mock an account servicing entity that has deployed Rafiki, exposing an [SPSP](https://rafiki.dev/resources/glossary#simple-payment-setup-protocol-spsp) endpoint, the [Open Payments](https://rafiki.dev/overview/concepts/open-payments) APIs with its required [GNAP](https://rafiki.dev/resources/glossary#grant-negotiation-and-authorization-protocol-gnap) auth endpoints to request grants, a STREAM endpoint for receiving Interledger packets, and a UI to view and manage the Rafiki instance.

These packages include:

- `backend` (SPSP, Open Payments APIs, GraphQL Admin APIs, STREAM endpoint)
- `auth` (GNAP auth server)
- `mock-account-servicing-entity` (mocks an [Account Servicing Entity](https://rafiki.dev/concepts/account-servicing-entity/)
- `mock-account-servicing-entity` (mocks an [account servicing entity](https://rafiki.dev/overview/overview)
- `frontend` (Remix app to expose a UI for Rafiki Admin management via interaction with the `backend` Admin APIs)
- `kratos` (An identity and user management solution for the `frontend`)
- `mailslurper` (A SMTP mail server to catch account recovery emails for the `frontend`)
Expand All @@ -27,7 +27,7 @@ This environment will set up a playground where you can use the Rafiki Admin API

## Environment overview

![Docker compose environment](../packages/documentation/public/img/localenv-architecture.png)
![Docker compose environment](../packages/documentation/public/img/localenv.png)

#### Cloud Nine Wallet

Expand Down Expand Up @@ -255,7 +255,7 @@ Note that you have to go through an interaction flow by clicking on the `redirec

#### Admin UI

In order to manage and view information about the Rafiki instance(s) you can use the [Rafiki Admin](https://rafiki.dev/rafikiadmin/overview/) UI. We have secured access to Rafiki Admin using [Ory Kratos](https://www.ory.sh/docs/kratos/ory-kratos-intro); however, in our local playground setup we've chosen to disable authorization for easier development and testing interactions.
In order to manage and view information about the Rafiki instance(s) you can use the [Rafiki Admin](https://rafiki.dev/admin/admin-user-guide) UI. We have secured access to Rafiki Admin using [Ory Kratos](https://www.ory.sh/docs/kratos/ory-kratos-intro); however, in our local playground setup we've chosen to disable authorization for easier development and testing interactions.

If you'd like to enable authorization locally you can run `pnpm localenv:compose:adminauth up` and check out the setup in the [`admin-auth`](./admin-auth/) subdirectory. Note that, if authorization is enabled, you must register separately for Cloud Nine Wallet's Rafiki Admin and Happy Life Bank's Rafiki Admin, as they are intended to operate as distinct mock account servicing entities. Once you've registered, you can always come back to your Rafiki Admin account by navigating to [`localhost:3010`](http://localhost:3010) (Cloud Nine Wallet) or [`localhost:4010`](http://localhost:4010) (Happy Life Bank) and logging in. Since access to the UI is on an invitation-only basis the registration flow is not publicly available. As such, in order to access Rafiki Admin you can manually add a new user with the invite-user script. Run `docker exec -it <admin-container-name> npm run invite-user -- [email protected]`, and it will output a link to the terminal. Copy and paste this link in your browser and you will automatically be logged in and directed to the account settings page. The next step is changing your password. We are using a simple email and password authentication method.

Expand Down
4 changes: 2 additions & 2 deletions localenv/mock-account-servicing-entity/app/root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ export default function App() {
This is an example application for an{' '}
<Link
className='cursor-pointer font-bold'
to='https://rafiki.dev/concepts/account-servicing-entity/'
to='https://rafiki.dev/resources/glossary#account-servicing-entity-ase'
>
[Account Servicing Entity]
[account servicing entity]
</Link>
, used for demonstration & internal development purposes only.
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Telemetry Collection

Currently, we collect packet count and packet amount metrics directly within the connector core. These metrics are captured at the Interledger layer to track packet activity while ensuring privacy by collecting amounts at the packet level, rather than at the transaction level. This approach helps to preserve privacy, as we do not expose entire transaction amounts, while also incorporating privacy-preserving measures into the collected amounts. You can read more about privacy [here](https://rafiki.dev/telemetry/privacy/).
Currently, we collect packet count and packet amount metrics directly within the connector core. These metrics are captured at the Interledger layer to track packet activity while ensuring privacy by collecting amounts at the packet level, rather than at the transaction level. This approach helps to preserve privacy, as we do not expose entire transaction amounts, while also incorporating privacy-preserving measures into the collected amounts. You can read more about privacy [here](https://rafiki.dev/overview/concepts/telemetry#privacy).

### Why We Collect on the Sending Side

Expand Down
8 changes: 4 additions & 4 deletions packages/documentation/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ dist/
# generated types
.astro/

# generated docs
src/content/docs/apis/auth/*
src/content/docs/apis/backend/*

# dependencies
node_modules/

Expand All @@ -26,3 +22,7 @@ pnpm-debug.log*

# editors
.vscode

# generated docs
src/content/docs/apis/graphql/auth/*
src/content/docs/apis/graphql/backend/*
Loading
Loading