From bd69f83961c94222b83003d825586a26a3eaf0db Mon Sep 17 00:00:00 2001 From: Sam Bukowski Date: Fri, 19 Jan 2024 12:41:17 -0700 Subject: [PATCH] bare link fixes --- .../astria-evm/{1-overview.md => overview.md} | 8 ++-- docs/cloud-rollup/digital-ocean.mdx | 15 +++--- docs/components/_astria-cli-install.mdx | 18 +++---- docs/components/_cli-cloud.mdx | 4 +- docs/components/_cli-local.mdx | 12 ++--- package.json | 8 +++- yarn.lock | 47 +++++++++++-------- 7 files changed, 62 insertions(+), 50 deletions(-) rename docs/astria-evm/{1-overview.md => overview.md} (65%) diff --git a/docs/astria-evm/1-overview.md b/docs/astria-evm/overview.md similarity index 65% rename from docs/astria-evm/1-overview.md rename to docs/astria-evm/overview.md index 38c6f60..dcd49b3 100644 --- a/docs/astria-evm/1-overview.md +++ b/docs/astria-evm/overview.md @@ -9,12 +9,12 @@ sidebar_position: 1 | Property | Value | |-----|-----| | Network Name | dusk-3 | -| RPC URL | | +| RPC URL | [https://rpc.evm.dusk-3.devnet.astria.org](https://rpc.evm.dusk-3.devnet.astria.org) | | Chain ID | 912559 | | Currency Symbol | RIA | -| Dora | | -| Faucet | | -| Block Scout | | +| Dora | [https://www.ondora.xyz/network/astria-devnet](https://www.ondora.xyz/network/astria-devnet) | +| Faucet | [https://faucet.evm.dusk-3.devnet.astria.org](https://faucet.evm.dusk-3.devnet.astria.org) | +| Block Scout | [https://explorer.evm.dusk-3.devnet.astria.org/](https://explorer.evm.dusk-3.devnet.astria.org/) | ## Adding to Metamask diff --git a/docs/cloud-rollup/digital-ocean.mdx b/docs/cloud-rollup/digital-ocean.mdx index afc5113..e2576fe 100644 --- a/docs/cloud-rollup/digital-ocean.mdx +++ b/docs/cloud-rollup/digital-ocean.mdx @@ -24,7 +24,7 @@ import RemoteEndpoints from '../components/_remote-endpoints.mdx'; This guide assumes you're using Digital Ocean's Kubernetes (K8s) service. -Install and configure `doctl`: +Install and configure `doctl`: [https://docs.digitalocean.com/reference/doctl/how-to/install/](https://docs.digitalocean.com/reference/doctl/how-to/install/) Follow the instructions in Digital Ocean's [Quick Start Guide](https://docs.digitalocean.com/products/kubernetes/getting-started/) to create a new cluster in the region of your choosing. @@ -49,8 +49,7 @@ This will create several Kubernetes (k8s) resources and a Digital Ocean loadbala ## Verify Loadbalancer with external IP -You should see a new loadbalancer being created in the Digital Ocean console: - +You should see a new loadbalancer being created in the Digital Ocean console: [https://cloud.digitalocean.com/networking/load_balancers](https://cloud.digitalocean.com/networking/load_balancers) You can also check that your Digital Ocean load balancer was created with: @@ -78,7 +77,7 @@ More info can be found [here](https://kubernetes.io/docs/concepts/services-netwo How you create an `A` record will depend on where you manage your domain. -An example for Google domains can be seen here: +An example for Google domains can be seen here: [https://support.google.com/a/answer/2579934?hl=en](https://support.google.com/a/answer/2579934?hl=en) Create a wildcard record `*` pointing to the `EXTERNAL-IP` of your `ingress-nginx-controller`: @@ -214,7 +213,7 @@ export SEQUENCER_ACCOUNT_ADDRESS=8a2f...5f68 ## Fund your Sequencer Account -Navigate to +Navigate to [https://faucet.sequencer.dusk-3.devnet.astria.org/](https://faucet.sequencer.dusk-3.devnet.astria.org/) to view the sequencer faucet. Enter your `` into the text box @@ -262,9 +261,9 @@ several public endpoints using the DNS you configured: | Utility | URL | |-----|-----| -| Block Explorer | ../ | -| Faucet | ../ | -| RPC | ../ | +| Block Explorer | `http://blockscout../` | +| Faucet | `http://faucet../` | +| RPC | `http://executor../` | ## Interact with your Rollup diff --git a/docs/components/_astria-cli-install.mdx b/docs/components/_astria-cli-install.mdx index 382b8e7..8ef35a3 100644 --- a/docs/components/_astria-cli-install.mdx +++ b/docs/components/_astria-cli-install.mdx @@ -11,27 +11,27 @@ import TabItem from '@theme/TabItem'; - + ```bash curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-aarch64-apple-darwin.tar.gz > astria-cli.tar.gz tar -xvzf astria-cli.tar.gz - + ``` - + ```bash curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-x86_64-apple-darwin.tar.gz > astria-cli.tar.gz tar -xvzf astria-cli.tar.gz - + ``` - + ```bash curl -L https://github.com/astriaorg/astria/releases/download/cli-v0.2.2/astria-cli-x86_64-unknown-linux-gnu.tar.gz > astria-cli.tar.gz tar -xvzf astria-cli.tar.gz - + ``` - + ```bash cargo install astria-cli --git=https://github.com/astriaorg/astria --tag=cli-v0.2.2 --locked - + ``` @@ -39,6 +39,6 @@ You'll also need to install the following tools: :::warning There is a bug in the latest Docker desktop release for MacOS -Please install the following release: +Please install the following release: [https://docs.docker.com/desktop/release-notes/#4252](https://docs.docker.com/desktop/release-notes/#4252) For more details see [here](https://github.com/docker/for-mac/issues/7100) ::: diff --git a/docs/components/_cli-cloud.mdx b/docs/components/_cli-cloud.mdx index 27dbcb6..14f3989 100644 --- a/docs/components/_cli-cloud.mdx +++ b/docs/components/_cli-cloud.mdx @@ -2,5 +2,5 @@ import CLI from '../components/_astria-cli-install.mdx'; -- kubectl - -- helm - +- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/) +- helm - [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/) diff --git a/docs/components/_cli-local.mdx b/docs/components/_cli-local.mdx index eac644f..8072dd2 100644 --- a/docs/components/_cli-local.mdx +++ b/docs/components/_cli-local.mdx @@ -2,10 +2,10 @@ import CLI from '../components/_astria-cli-install.mdx'; -- docker - -- kubectl - -- helm - -- kind - -- just - +- docker - [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) +- kubectl - [https://kubernetes.io/docs/tasks/tools/](https://kubernetes.io/docs/tasks/tools/) +- helm - [https://helm.sh/docs/intro/install/](https://helm.sh/docs/intro/install/) +- kind - [https://kind.sigs.k8s.io/docs/user/quick-start/#installation](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) +- just - [https://just.systems/man/en/chapter_4.html](https://just.systems/man/en/chapter_4.html) - Foundry Cast and Forge tools - - + [https://book.getfoundry.sh/getting-started/installation](https://book.getfoundry.sh/getting-started/installation) diff --git a/package.json b/package.json index e8ec9d3..ed161bd 100644 --- a/package.json +++ b/package.json @@ -17,17 +17,21 @@ "fmt": "eslint --fix docs/**/*.md src/**/*.tsx" }, "dependencies": { + "@algolia/client-search": "^4.22.1", "@docusaurus/core": "^3.1.0", "@docusaurus/preset-classic": "^3.1.0", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", "prism-react-renderer": "^1.3.5", - "react": "^17.0.2", - "react-dom": "^17.0.2" + "react": "^18.0.0", + "react-dom": "^18.0.0", + "react-loadable": "^5.5.0", + "search-insights": "^2.13.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.1.0", "@tsconfig/docusaurus": "^1.0.5", + "@types/react": "^18.2.48", "@typescript-eslint/eslint-plugin": "^6.8.0", "@typescript-eslint/parser": "^6.8.0", "eslint": "^8.51.0", diff --git a/yarn.lock b/yarn.lock index cc009b2..f416d03 100644 --- a/yarn.lock +++ b/yarn.lock @@ -89,7 +89,7 @@ "@algolia/requester-common" "4.22.1" "@algolia/transporter" "4.22.1" -"@algolia/client-search@4.22.1": +"@algolia/client-search@4.22.1", "@algolia/client-search@^4.22.1": version "4.22.1" resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.22.1.tgz#508cc6ab3d1f4e9c02735a630d4dff6fbb8514a2" integrity sha512-yb05NA4tNaOgx3+rOxAmFztgMTtGBi97X7PC3jyNeGiwkAjOZc2QrdZBYyIdcDLoI09N0gjtpClcackoTN0gPA== @@ -2370,7 +2370,7 @@ "@types/history" "^4.7.11" "@types/react" "*" -"@types/react@*": +"@types/react@*", "@types/react@^18.2.48": version "18.2.48" resolved "https://registry.yarnpkg.com/@types/react/-/react-18.2.48.tgz#11df5664642d0bd879c1f58bc1d37205b064e8f1" integrity sha512-qboRCl6Ie70DQQG9hhNREz81jqC1cs9EVNcjQ1AU+jH6NFfSAhVVbrrY/+nSF+Bsk4AOwm9Qa61InvMCyV+H3w== @@ -7980,7 +7980,7 @@ prompts@^2.4.2: kleur "^3.0.3" sisteransi "^1.0.5" -prop-types@^15.6.2, prop-types@^15.7.2: +prop-types@^15.5.0, prop-types@^15.6.2, prop-types@^15.7.2: version "15.8.1" resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.8.1.tgz#67d87bf1a694f48435cf332c24af10214a3140b5" integrity sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg== @@ -8115,14 +8115,13 @@ react-dev-utils@^12.0.1: strip-ansi "^6.0.1" text-table "^0.2.0" -react-dom@^17.0.2: - version "17.0.2" - resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-17.0.2.tgz#ecffb6845e3ad8dbfcdc498f0d0a939736502c23" - integrity sha512-s4h96KtLDUQlsENhMn1ar8t2bEa+q/YAtj8pPPdIjPDGBDIVNsrD9aXNWqspUe6AzKCIG0C1HZZLqLV7qpOBGA== +react-dom@^18.0.0: + version "18.2.0" + resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-18.2.0.tgz#22aaf38708db2674ed9ada224ca4aa708d821e3d" + integrity sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g== dependencies: loose-envify "^1.1.0" - object-assign "^4.1.1" - scheduler "^0.20.2" + scheduler "^0.23.0" react-error-overlay@^6.0.11: version "6.0.11" @@ -8171,6 +8170,13 @@ react-loadable-ssr-addon-v5-slorber@^1.0.1: dependencies: "@babel/runtime" "^7.10.3" +react-loadable@^5.5.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/react-loadable/-/react-loadable-5.5.0.tgz#582251679d3da86c32aae2c8e689c59f1196d8c4" + integrity sha512-C8Aui0ZpMd4KokxRdVAm2bQtI03k2RMRNzOB+IipV3yxFTSVICv7WoUr5L9ALB5BmKO1iHgZtWM8EvYG83otdg== + dependencies: + prop-types "^15.5.0" + react-router-config@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/react-router-config/-/react-router-config-5.1.1.tgz#0f4263d1a80c6b2dc7b9c1902c9526478194a988" @@ -8206,13 +8212,12 @@ react-router@5.3.4, react-router@^5.3.4: tiny-invariant "^1.0.2" tiny-warning "^1.0.0" -react@^17.0.2: - version "17.0.2" - resolved "https://registry.yarnpkg.com/react/-/react-17.0.2.tgz#d0b5cc516d29eb3eee383f75b62864cfb6800037" - integrity sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA== +react@^18.0.0: + version "18.2.0" + resolved "https://registry.yarnpkg.com/react/-/react-18.2.0.tgz#555bd98592883255fa00de14f1151a917b5d77d5" + integrity sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ== dependencies: loose-envify "^1.1.0" - object-assign "^4.1.1" read-package-json-fast@^3.0.0, read-package-json-fast@^3.0.2: version "3.0.2" @@ -8584,13 +8589,12 @@ sax@^1.2.4: resolved "https://registry.yarnpkg.com/sax/-/sax-1.3.0.tgz#a5dbe77db3be05c9d1ee7785dbd3ea9de51593d0" integrity sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA== -scheduler@^0.20.2: - version "0.20.2" - resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.20.2.tgz#4baee39436e34aa93b4874bddcbf0fe8b8b50e91" - integrity sha512-2eWfGgAqqWFGqtdMmcL5zCMK1U8KlXv8SQFGglL3CEtd0aDVDWgeF/YoCmvln55m5zSk3J/20hTaSBeSObsQDQ== +scheduler@^0.23.0: + version "0.23.0" + resolved "https://registry.yarnpkg.com/scheduler/-/scheduler-0.23.0.tgz#ba8041afc3d30eb206a487b6b384002e4e61fdfe" + integrity sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw== dependencies: loose-envify "^1.1.0" - object-assign "^4.1.1" schema-utils@2.7.0: version "2.7.0" @@ -8620,6 +8624,11 @@ schema-utils@^4.0.0: ajv-formats "^2.1.1" ajv-keywords "^5.1.0" +search-insights@^2.13.0: + version "2.13.0" + resolved "https://registry.yarnpkg.com/search-insights/-/search-insights-2.13.0.tgz#a79fdcf4b5dad2fba8975b06f2ebc37a865032b7" + integrity sha512-Orrsjf9trHHxFRuo9/rzm0KIWmgzE8RMlZMzuhZOJ01Rnz3D0YBAe+V6473t6/H6c7irs6Lt48brULAiRWb3Vw== + section-matter@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/section-matter/-/section-matter-1.0.0.tgz#e9041953506780ec01d59f292a19c7b850b84167"