From 8f89592714306ebf3cb5217bb433bfa0ea29fb1e Mon Sep 17 00:00:00 2001 From: zeme Date: Mon, 8 Jul 2024 16:03:33 +0200 Subject: [PATCH] Fix broken linkchecker CI --- .github/workflows/docusaurus-site.yml | 3 ++- .github/workflows/haddock-site.yml | 5 +++-- .github/workflows/metatheory-site.yml | 5 +++-- doc/docusaurus/README.md | 2 +- .../docs/essential-concepts/plutus-foundation.md | 2 +- .../docs/essential-concepts/plutus-platform.mdx | 2 +- doc/docusaurus/docs/index.md | 6 +++--- doc/docusaurus/docs/reference/haddock-documentation.md | 10 +++++----- 8 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.github/workflows/docusaurus-site.yml b/.github/workflows/docusaurus-site.yml index a71639621f7..a936b247baf 100644 --- a/.github/workflows/docusaurus-site.yml +++ b/.github/workflows/docusaurus-site.yml @@ -38,7 +38,8 @@ jobs: --ignore-url "https://plutus.cardano.intersectmbo.org/haddock/.*" ) URL="https://plutus.cardano.intersectmbo.org/docs" - linkchecker --no-warnings --check-extern --output failures "${URL}" "${IGNORE_URLS[@]}" + nix develop --no-warn-dirty --accept-flake-config --command \ + linkchecker --no-warnings --check-extern --output failures "${URL}" "${IGNORE_URLS[@]}" if [ $? -ne 0 ]; then echo "${URL} has broken links, see output above" exit 1 diff --git a/.github/workflows/haddock-site.yml b/.github/workflows/haddock-site.yml index 99dee8f8106..b783faac544 100644 --- a/.github/workflows/haddock-site.yml +++ b/.github/workflows/haddock-site.yml @@ -350,9 +350,10 @@ jobs: --ignore-url .*/prettyprinter-configurable/src ) URL="https://plutus.cardano.intersectmbo.org/haddock/${{ inputs.destination || github.ref_name }}" - linkchecker --no-warnings --check-extern --output failures "${URL}" "${IGNORE_URLS}" + nix develop --no-warn-dirty --accept-flake-config --command \ + linkchecker --no-warnings --check-extern --output failures "${URL}" "${IGNORE_URLS}" if [ $? -ne 0 ]; then - echo "${URL}" has broken links, see output above" + echo "${URL} has broken links, see output above" exit 1 fi diff --git a/.github/workflows/metatheory-site.yml b/.github/workflows/metatheory-site.yml index 4b0cc67ae79..a26e581fce0 100644 --- a/.github/workflows/metatheory-site.yml +++ b/.github/workflows/metatheory-site.yml @@ -36,8 +36,9 @@ jobs: - name: Check Broken Links run: | URL="https://plutus.cardano.intersectmbo.org/metatheory" - linkchecker --no-warnings --check-extern --output failures "${URL}" + nix develop --no-warn-dirty --accept-flake-config --command \ + linkchecker --no-warnings --check-extern --output failures "${URL}" if [ $? -ne 0 ]; then - echo "${URL}" has broken links, see output above" + echo "${URL} has broken links, see output above" exit 1 fi \ No newline at end of file diff --git a/doc/docusaurus/README.md b/doc/docusaurus/README.md index fa454557233..09e72352fe0 100644 --- a/doc/docusaurus/README.md +++ b/doc/docusaurus/README.md @@ -19,4 +19,4 @@ yarn start # for live development on localhost Go to the [docusaurus-site.yml](https://github.com/IntersectMBO/plutus/actions/workflows/docusaurus-site.yml) workflow and click `Run workflow` on the right. -This will build and publish the website to [GitHub pages](https://plutus.cardano.intersectmbo.org/plutus/docs). \ No newline at end of file +This will build and publish the website to [GitHub pages](https://plutus.cardano.intersectmbo.org/docs). \ No newline at end of file diff --git a/doc/docusaurus/docs/essential-concepts/plutus-foundation.md b/doc/docusaurus/docs/essential-concepts/plutus-foundation.md index 11661ff9e45..882fbdfa3ed 100644 --- a/doc/docusaurus/docs/essential-concepts/plutus-foundation.md +++ b/doc/docusaurus/docs/essential-concepts/plutus-foundation.md @@ -36,4 +36,4 @@ Supporting "mixed" code in this way enables libraries written with the Plutus Ha The formal details of Plutus Core are in its [specification](https://github.com/IntersectMBO/plutus#specifications-and-design). -The design is discussed in the [technical report](https://plutus.cardano.intersectmbo.org/plutus/resources/plutus-report.pdf). +The design is discussed in the [technical report](https://plutus.cardano.intersectmbo.org/resources/plutus-report.pdf). diff --git a/doc/docusaurus/docs/essential-concepts/plutus-platform.mdx b/doc/docusaurus/docs/essential-concepts/plutus-platform.mdx index e72ac1d24d3..03c9d999028 100644 --- a/doc/docusaurus/docs/essential-concepts/plutus-platform.mdx +++ b/doc/docusaurus/docs/essential-concepts/plutus-platform.mdx @@ -87,5 +87,5 @@ Even simple applications must deal with this complexity, and for more advanced a - Michael Peyton-Jones and Jann Mueller introduce the Plutus platform in [this session](https://youtu.be/usMPt8KpBeI?si=4zkS3J7Bq8aFxWbU) from the Cardano 2020 event. -- The design of the platform is discussed in the [Plutus technical report](https://plutus.cardano.intersectmbo.org/plutus/resources/plutus-report.pdf). +- The design of the platform is discussed in the [Plutus technical report](https://plutus.cardano.intersectmbo.org/resources/plutus-report.pdf). diff --git a/doc/docusaurus/docs/index.md b/doc/docusaurus/docs/index.md index 0512a107681..34c7e02d497 100644 --- a/doc/docusaurus/docs/index.md +++ b/doc/docusaurus/docs/index.md @@ -17,7 +17,7 @@ All of these elements are used in combination to write Plutus Core scripts that To develop and deploy a smart contract, you also need off-chain code for building transactions, submitting transactions, deploying smart contracts, querying for available UTXOs on the chain, and so on. You may also want a front-end interface for your smart contract for a better user experience. -Plutus allows all programming to be done from a [single Haskell library](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest). This lets developers build secure applications, forge new assets, and create smart contracts in a predictable, deterministic environment with the highest level of assurance. Furthemore, developers don’t have to run a full Cardano node to test their work. +Plutus allows all programming to be done from a [single Haskell library](https://plutus.cardano.intersectmbo.org/haddock/latest). This lets developers build secure applications, forge new assets, and create smart contracts in a predictable, deterministic environment with the highest level of assurance. Furthemore, developers don’t have to run a full Cardano node to test their work. With Plutus you can: @@ -38,7 +38,7 @@ See, for example: - the [Cardano ledger specification](https://github.com/IntersectMBO/cardano-ledger#cardano-ledger) - the [Plutus Core specification](https://github.com/IntersectMBO/plutus#specifications-and-design) -- the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest) generated using Haddock. +- the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/haddock/latest) generated using Haddock. ## The Plutus repository @@ -46,7 +46,7 @@ The [Plutus repository](https://github.com/IntersectMBO/plutus) includes: * the implementation, specification, and mechanized metatheory of Plutus Core * the Plutus Tx compiler -* the combined documentation, generated using Haddock, for all the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest), such as `PlutusTx.List`, enabling developers to write Haskell code that can be compiled to Plutus Core. +* the combined documentation, generated using Haddock, for all the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/haddock/latest), such as `PlutusTx.List`, enabling developers to write Haskell code that can be compiled to Plutus Core. ## Educational resources diff --git a/doc/docusaurus/docs/reference/haddock-documentation.md b/doc/docusaurus/docs/reference/haddock-documentation.md index c9d9fb8d5d5..8436c7008ce 100644 --- a/doc/docusaurus/docs/reference/haddock-documentation.md +++ b/doc/docusaurus/docs/reference/haddock-documentation.md @@ -6,12 +6,12 @@ sidebar_position: 3 ## Public Plutus code libraries -The documentation generated by Haddock provides a comprehehsive reference for the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest), an essential resource for developers working with Haskell and Plutus Core. +The documentation generated by Haddock provides a comprehehsive reference for the [public Plutus code libraries](https://plutus.cardano.intersectmbo.org/haddock/latest), an essential resource for developers working with Haskell and Plutus Core. ### Highlighted modules Highlighted modules in the documentation include the following: -- [PlutusTx](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest/plutus-tx/PlutusTx.html): compiling Haskell to PLC (Plutus Core; on-chain code) -- [PlutusTx.Prelude](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest/plutus-tx/PlutusTx-Prelude.html): Haskell prelude replacement compatible with PLC -- [PlutusCore](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest/plutus-core/PlutusCore.html): programming language in which scripts on the Cardano blockchain are written -- [UntypedPlutusCore](https://plutus.cardano.intersectmbo.org/plutus/haddock/latest/plutus-core/UntypedPlutusCore.html): on-chain Plutus code. +- [PlutusTx](https://plutus.cardano.intersectmbo.org/haddock/latest/plutus-tx/PlutusTx.html): compiling Haskell to PLC (Plutus Core; on-chain code) +- [PlutusTx.Prelude](https://plutus.cardano.intersectmbo.org/haddock/latest/plutus-tx/PlutusTx-Prelude.html): Haskell prelude replacement compatible with PLC +- [PlutusCore](https://plutus.cardano.intersectmbo.org/haddock/latest/plutus-core/PlutusCore.html): programming language in which scripts on the Cardano blockchain are written +- [UntypedPlutusCore](https://plutus.cardano.intersectmbo.org/haddock/latest/plutus-core/UntypedPlutusCore.html): on-chain Plutus code.