Skip to content

Commit

Permalink
feat: add starlight links validator (#477)
Browse files Browse the repository at this point in the history
* Add starlight links validator

* Fix broken links
  • Loading branch information
huijing authored May 29, 2024
1 parent 35ce0cf commit 23dca59
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 31 deletions.
8 changes: 7 additions & 1 deletion docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { defineConfig } from 'astro/config'
import starlight from '@astrojs/starlight'
import starlightOpenAPI from 'starlight-openapi'
import starlightLinksValidator from 'starlight-links-validator'

// https://astro.build/config
export default defineConfig({
Expand Down Expand Up @@ -45,7 +46,12 @@ export default defineConfig({
label: 'Open Payments Authorization Server',
schema: '../openapi/auth-server.yaml'
}
])
]),
starlightLinksValidator({
exclude: [
'/apis/{auth-server,resource-server,wallet-address-server}/**/*'
]
})
],
sidebar: [
{
Expand Down
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
"mermaid": "^10.9.0",
"sharp": "^0.33.3",
"shiki": "1.4.0",
"starlight-openapi": "^0.6.3"
"starlight-openapi": "^0.6.3",
"starlight-links-validator": "^0.9.0"
},
"devDependencies": {
"prettier": "3.2.5"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/introduction/op-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ A successfully created `quote` resource results in the generation of a quote `id

After a quote resource is created, it’s almost time to create the outgoing-payment resource on the payer’s account. The purpose of the outgoing-payment resource is to serve as an instruction to make a payment from the payer’s account.

Open Payments requires the payer to explicitly consent to the creation of the resource before the client can issue the create request. Consent is obtained through an [interactive grant](/introduction/grants/#outgoing-payment-grant).
Open Payments requires the payer to explicitly consent to the creation of the resource before the client can issue the create request. Consent is obtained through an [interactive grant](/introduction/grants/#outgoing-payment).

Within the request to create the outgoing-payment resource is the payee’s wallet address, so the payer’s ASE knows where to send the payment, and the quote resource’s ID, where the payment amounts are defined.

Expand Down
63 changes: 35 additions & 28 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 23dca59

Please sign in to comment.