diff --git a/docs/README.md b/docs/README.md index b59926ca..9041a98c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -61,7 +61,6 @@ Refer to the Starlight documentation on [authoring content](https://starlight.as We have extracted some of the commonly repeated patterns within the documentation pages into custom docs components that can be reused. There are components which are shared across all our Starlight documentation sites and those which are specific to this project only. This will determine what the import path is. - CodeBlock (Shared) -- Disclosure (Shared) - Hidden (Shared) - LargeImg (Shared) - LinkOut (Shared) @@ -72,10 +71,10 @@ We have extracted some of the commonly repeated patterns within the documentatio - [FullSnippet](#fullsnippet-component) (Project-specific) - [ChunkedSnippet](#chunkedsnippet-component) (Project-specific) -For the shared components, if you are using both `CodeBlock` and `Disclosure` on the same page, you can import them both like so: +For the shared components, if you are using both `CodeBlock` and `Tooltip` on the same page, you can import them both like so: ```jsx -import { CodeBlock, Disclosure } from '@interledger/docs-design-system' +import { CodeBlock, Tooltip } from '@interledger/docs-design-system' ``` For more information about importing things in Javascript, please refer to [import on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import). diff --git a/docs/src/content/docs/snippets/grant-continue.mdx b/docs/src/content/docs/snippets/grant-continue.mdx index b3702a19..220d7327 100644 --- a/docs/src/content/docs/snippets/grant-continue.mdx +++ b/docs/src/content/docs/snippets/grant-continue.mdx @@ -2,7 +2,7 @@ title: Continue a grant request --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/grant-create.mdx b/docs/src/content/docs/snippets/grant-create.mdx index 36bad820..0993efde 100644 --- a/docs/src/content/docs/snippets/grant-create.mdx +++ b/docs/src/content/docs/snippets/grant-create.mdx @@ -2,7 +2,7 @@ title: Create a grant request --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/grant-revoke.mdx b/docs/src/content/docs/snippets/grant-revoke.mdx index 579997f5..7052e3b9 100644 --- a/docs/src/content/docs/snippets/grant-revoke.mdx +++ b/docs/src/content/docs/snippets/grant-revoke.mdx @@ -2,7 +2,7 @@ title: Revoke a grant request --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/incoming-complete.mdx b/docs/src/content/docs/snippets/incoming-complete.mdx index 35c42c83..533884e5 100644 --- a/docs/src/content/docs/snippets/incoming-complete.mdx +++ b/docs/src/content/docs/snippets/incoming-complete.mdx @@ -2,7 +2,7 @@ title: Complete an incoming payment --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/incoming-create.mdx b/docs/src/content/docs/snippets/incoming-create.mdx index 612950d7..d71bc76a 100644 --- a/docs/src/content/docs/snippets/incoming-create.mdx +++ b/docs/src/content/docs/snippets/incoming-create.mdx @@ -2,7 +2,7 @@ title: Create an incoming payment --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/incoming-get.mdx b/docs/src/content/docs/snippets/incoming-get.mdx index 762fb59a..c9c98595 100644 --- a/docs/src/content/docs/snippets/incoming-get.mdx +++ b/docs/src/content/docs/snippets/incoming-get.mdx @@ -2,7 +2,7 @@ title: Get an incoming payment --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/incoming-list.mdx b/docs/src/content/docs/snippets/incoming-list.mdx index c31651ac..42082b76 100644 --- a/docs/src/content/docs/snippets/incoming-list.mdx +++ b/docs/src/content/docs/snippets/incoming-list.mdx @@ -2,7 +2,7 @@ title: List incoming payments --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/outgoing-create.mdx b/docs/src/content/docs/snippets/outgoing-create.mdx index 0871f5e9..ca80b1a0 100644 --- a/docs/src/content/docs/snippets/outgoing-create.mdx +++ b/docs/src/content/docs/snippets/outgoing-create.mdx @@ -2,7 +2,7 @@ title: Create an outgoing payment --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/outgoing-list.mdx b/docs/src/content/docs/snippets/outgoing-list.mdx index c8518955..9f46f120 100644 --- a/docs/src/content/docs/snippets/outgoing-list.mdx +++ b/docs/src/content/docs/snippets/outgoing-list.mdx @@ -2,7 +2,7 @@ title: List outgoing payments --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/quote-create.mdx b/docs/src/content/docs/snippets/quote-create.mdx index 474e0f32..2c07af20 100644 --- a/docs/src/content/docs/snippets/quote-create.mdx +++ b/docs/src/content/docs/snippets/quote-create.mdx @@ -2,7 +2,7 @@ title: Create a quote --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/quote-get.mdx b/docs/src/content/docs/snippets/quote-get.mdx index 01ae66f2..821c2399 100644 --- a/docs/src/content/docs/snippets/quote-get.mdx +++ b/docs/src/content/docs/snippets/quote-get.mdx @@ -2,7 +2,7 @@ title: Get a quote --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/content/docs/snippets/wallet-get-keys.mdx b/docs/src/content/docs/snippets/wallet-get-keys.mdx index 51d73d78..3c768c7c 100644 --- a/docs/src/content/docs/snippets/wallet-get-keys.mdx +++ b/docs/src/content/docs/snippets/wallet-get-keys.mdx @@ -2,7 +2,7 @@ title: Get keys bound to a wallet address --- -import { Disclosure, CodeBlock, LinkOut } from '@interledger/docs-design-system' +import { CodeBlock, LinkOut } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' import Begin from '/src/partials/before-you-begin.mdx' diff --git a/docs/src/partials/code-snippets-template.mdx b/docs/src/partials/code-snippets-template.mdx index 43679300..b9a2e943 100644 --- a/docs/src/partials/code-snippets-template.mdx +++ b/docs/src/partials/code-snippets-template.mdx @@ -2,7 +2,7 @@ title: Change this title --- -import { Disclosure, CodeBlock } from '@interledger/docs-design-system' +import { CodeBlock } from '@interledger/docs-design-system' import { Tabs, TabItem } from '@astrojs/starlight/components' import FullSnippet from '/src/components/FullSnippet.astro' import ChunkedSnippet from '/src/components/ChunkedSnippet.astro' @@ -30,9 +30,10 @@ import Ts from '/src/partials/ts-prerequisites.mdx' - +
+View full source -Delete the contents of this disclosure and replace it with a link to the raw source +Delete the contents of this details tag and replace it with a link to the raw source file like so: ```html @@ -41,7 +42,7 @@ file like so: /> ``` - +
## References diff --git a/docs/src/partials/js-prerequisites.mdx b/docs/src/partials/js-prerequisites.mdx index 106685f1..ea3591d5 100644 --- a/docs/src/partials/js-prerequisites.mdx +++ b/docs/src/partials/js-prerequisites.mdx @@ -1,6 +1,7 @@ -import { LinkOut, Disclosure } from '@interledger/docs-design-system' +import { LinkOut } from '@interledger/docs-design-system' - +
+Prerequisites - Node 18 or higher - A package manager such as NPM or PNPM @@ -12,4 +13,4 @@ import { LinkOut, Disclosure } from '@interledger/docs-design-system' Add `"type": "module"` to `package.json` - +
diff --git a/docs/src/partials/ts-prerequisites.mdx b/docs/src/partials/ts-prerequisites.mdx index 75e95c7f..1062cf51 100644 --- a/docs/src/partials/ts-prerequisites.mdx +++ b/docs/src/partials/ts-prerequisites.mdx @@ -1,6 +1,7 @@ -import { LinkOut, Disclosure } from '@interledger/docs-design-system' +import { LinkOut } from '@interledger/docs-design-system' - +
+Prerequisites - Node 18 - A package manager such as NPM or PNPM @@ -24,4 +25,4 @@ Add the following to `tsconfig.json` } ``` - +