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 <[email protected]> * style edits update docusaurus/docs/reference/haddock-documentation.md Co-authored-by: olgahryniuk <[email protected]> --------- Co-authored-by: olgahryniuk <[email protected]>
IntersectMBO · Jun 12, 2024 · 56c90bf · 56c90bf
1 parent 6910d70
commit 56c90bf
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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.