From 56c90bfb22700794de817d2f69c77e4a554131a3 Mon Sep 17 00:00:00 2001 From: Joseph Fajen <104791413+joseph-fajen@users.noreply.github.com> Date: Wed, 12 Jun 2024 09:47:33 -0700 Subject: [PATCH] Docs raise visibility code libraries (#6203) * added more visibility to Haddock Plutus code libraries on index.md page * adding new Haddock documentation page under the Reference nav menu * updated Reference top-level page description * minor style edit update docusaurus/docs/index.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> * style edits update docusaurus/docs/reference/haddock-documentation.md Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> --------- Co-authored-by: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> --- docusaurus/docs/index.md | 5 +++-- docusaurus/docs/reference/_category_.json | 2 +- .../docs/reference/haddock-documentation.md | 17 +++++++++++++++++ 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 docusaurus/docs/reference/haddock-documentation.md diff --git a/docusaurus/docs/index.md b/docusaurus/docs/index.md index a1475e1ee86..16c10903e45 100644 --- a/docusaurus/docs/index.md +++ b/docusaurus/docs/index.md @@ -36,8 +36,9 @@ This involves using Plutus Tx to write scripts, requiring some knowledge of the This guide is also meant for certification companies, certification auditors, and people who need an accurate specification. See, for example: -- the [Cardano Ledger Specification](https://github.com/IntersectMBO/cardano-ledger#cardano-ledger) and -- the [Plutus Core Specification](https://github.com/IntersectMBO/plutus#specifications-and-design). +- 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://intersectmbo.github.io/plutus/master/) generated using Haddock. ## The Plutus repository diff --git a/docusaurus/docs/reference/_category_.json b/docusaurus/docs/reference/_category_.json index 27452d0feff..75e113e805c 100644 --- a/docusaurus/docs/reference/_category_.json +++ b/docusaurus/docs/reference/_category_.json @@ -3,6 +3,6 @@ "position": 70, "link": { "type": "generated-index", - "description": "The Reference section covers Plutus Tx compiler options, script optimization techniques, common weaknesses, Plutus language changes, and how upgrading to Vasil can impact script addresses." + "description": "The Reference section covers Haddock documentation, Plutus Tx compiler options, script optimization techniques, common weaknesses, Plutus language changes, and how upgrading to Vasil can impact script addresses." } } diff --git a/docusaurus/docs/reference/haddock-documentation.md b/docusaurus/docs/reference/haddock-documentation.md new file mode 100644 index 00000000000..db6ca0ffeff --- /dev/null +++ b/docusaurus/docs/reference/haddock-documentation.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 3 +--- + +# Haddock documentation + +## Public Plutus code libraries + +The documentation generated by Haddock provides a comprehehsive reference for the [public Plutus code libraries](https://intersectmbo.github.io/plutus/master/), an essential resource for developers working with Haskell and Plutus Core. + +### Highlighted modules + +Highlighted modules in the documentation include the following: +- [PlutusTx](https://intersectmbo.github.io/plutus/master/plutus-tx/html/PlutusTx.html): compiling Haskell to PLC (Plutus Core; on-chain code) +- [PlutusTx.Prelude](https://intersectmbo.github.io/plutus/master/plutus-tx/html/PlutusTx-Prelude.html): Haskell prelude replacement compatible with PLC +- [PlutusCore](https://intersectmbo.github.io/plutus/master/plutus-core/html/PlutusCore.html): programming language in which scripts on the Cardano blockchain are written +- [UntypedPlutusCore](https://intersectmbo.github.io/plutus/master/plutus-core/html/UntypedPlutusCore.html): on-chain Plutus code.