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: add ILP link to peer typescript descriptions #2962

Closed
melissahenderson opened this issue Sep 11, 2024 · 0 comments
Closed

docs: add ILP link to peer typescript descriptions #2962

melissahenderson opened this issue Sep 11, 2024 · 0 comments
Assignees

Comments

@melissahenderson
Copy link
Contributor

Previously, the descriptions for the incomingAuthTokens and outgoingAuthToken parameters in the files below linked to a specific page within the Rafiki user docs.

  • /packages/frontend/app/routes/peers.$peerId.tsx
  • /packages/frontend/app/routes/peers.create.ts

The revised version of the Rafiki docs no longer contain the information these files linked to because the information was specific to Interledger, not Rafiki. The links were removed before publishing, so now the descriptions are simple text.

We need to find the best place to re-link to. Ideally, it will be somewhere within the Interledger developer docs/specs since the linked phrase was ILP packets. Other parameters in the files link to the Interledger specs, so it's OK to continue to do so.

  • incomingAuthTokens - List of valid tokens to accept when receiving incoming [ILP packets] from the peer.
  • outgoingAuthToken - Valid auth token to present when sending outgoing [ILP packets] to the peer.
@melissahenderson melissahenderson self-assigned this Sep 18, 2024
melissahenderson added a commit that referenced this issue Sep 23, 2024
Also deleted blank peering.mdx page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

No branches or pull requests

1 participant