Merge pull request #351 from Anastasia-Labs/updated-docs

documentation update: project showcase, chores

README.md

@@ -190,9 +190,6 @@ We welcome contributions to Lucid Evolution! Please feel free to submit issues,
 
 Lucid Evolution is open-source software licensed under the [MIT License](https://anastasia-labs.github.io/lucid-evolution/information/license)
 
-
-
-
 ## Community
 
 Join our [Discord community](https://discord.gg/s89P9gpEff) for discussions, support, and updates

docs/pages/_meta.json

@@ -30,6 +30,15 @@
     "type": "page"
   },
 
+  "showcase": {
+    "type": "page",
+    "title": "Showcase",
+    "theme": {
+      "typesetting": "article",
+      "layout": "default"
+    }
+  },
+
   "information": {
     "title": "Information",
     "type": "menu",

docs/pages/documentation/core-concepts/choose-wallet.mdx

@@ -1,6 +1,6 @@
 import { Callout, Steps } from "nextra/components";
 
-# Create a wallet
+## Create a wallet
 
 You are provided multiple options to create and import a wallet
 

docs/pages/documentation/core-concepts/first-transaction.mdx

@@ -1,6 +1,6 @@
 import { Callout, Steps } from "nextra/components";
 
-# Your first transaction
+## Your first transaction
 
 <Steps>
 ### Build
@@ -23,7 +23,7 @@ const tx = await lucid
 <Callout type="info" emoji="ℹ️">
   __Evolution-Notes:__ `payToAddress` -> `pay.ToAddress`
 </Callout>
-### Sign{" "}
+### Sign
 
 ```typescript
 const signedTx = await tx.sign.withWallet().complete();

docs/pages/documentation/deep-dives/emulator.mdx

@@ -9,7 +9,7 @@ Emulator allows developers to test and validate their transactions in a controll
 ---
 
 <Steps>
-### Initialize emulator
+## Initialize emulator
 
 This setup allows you to create a mock blockchain state with predefined addresses and asset distributions
 

docs/pages/documentation/deep-dives/smart-contract-interactions.mdx

@@ -1,6 +1,6 @@
 import { Callout, Steps } from "nextra/components";
 
-# Smart Contract Interactions
+## Smart Contract Interactions
 
 It's important to understand that on the Cardano blockchain, you don't directly interact with "smart contracts", atleast not in the traditional sense.
 

docs/pages/documentation/examples/_meta.json

@@ -1,5 +1,18 @@
 {
   "hello-world":"Hello World",
   "design-patterns":"Design Patterns",
-  "emulated-testing-framework":"Testing Framework via Emulator"
-}
+  "emulated-testing-framework":"Testing Framework via Emulator",
+  "---": {
+    "type": "separator"
+  },
+  "smart-handles-offchain": {
+    "title": "Smart Handles Offchain  ⤴",
+    "href": "https://github.com/Anastasia-Labs/smart-handles-offchain",
+    "newWindow": true
+  },
+  "mint-chocolate-chip": {
+    "title": "Mint Chocolate Chip  ⤴",
+    "href": "https://github.com/MynthAI/mint-chocolate-chip",
+    "newWindow": true
+  }
+}

docs/pages/documentation/keeping-pace-with-cardano/conway-era.mdx

@@ -1,4 +1,4 @@
-import { Callout } from "nextra/components";
+import { Callout, Steps } from "nextra/components";
 
 ## Governance and Conway Era
 
@@ -13,6 +13,8 @@ Lucid Evolution now supports various governance actions as defined in CIP-1694.
 
 As an ADA holder, you can participate in governance through various voting strategies and delegation options.
 
+<Steps>
+
 ### Delegation Options
 
 #### Delegate Vote to DRep
@@ -32,6 +34,8 @@ await lucid.newTx()
   .delegate.VoteToPoolAndDrep(rewardAddress, poolId, drep)
 ```
 
+---
+
 ### Registration and Delegation
 #### Register and Delegate to DRep
 
@@ -60,6 +64,8 @@ await lucid.newTx()
     })
 ```
 
+---
+
 ### Voting Strategies
 
 #### Always Abstain
@@ -90,14 +96,18 @@ await lucid.newTx()
     })
 ```
 
+</Steps>
+
 <Callout>
-Choosing `AlwaysNoConfidence` or `AlwaysAbstain` requires a DRep object with `__typename` property set to the desired value, as it can be observed in the examples abover
+Choosing `AlwaysNoConfidence` or `AlwaysAbstain` requires a DRep object with `__typename` property set to the desired value, as it can be observed in the examples above
 </Callout>
 
 ## As a DRep
 
 As a DRep, you can perform the following actions
 
+<Steps>
+
 ### Register as a DRep
 
 Registers a stake address as a DRep
@@ -107,6 +117,8 @@ await lucid.newTx()
   .register.DRep(rewardAddress)
 ```
 
+---
+
 ### Update DRep
 
 Updates the information of a DRep
@@ -116,6 +128,8 @@ await lucid.newTx()
   .updateDRep(rewardAddress)
 ```
 
+---
+
 ### Deregister DRep
 
 Deregisters your stake address as a DRep
@@ -125,11 +139,17 @@ await lucid.newTx()
   .deregister.DRep(rewardAddress)
 ```
 
+---
+
+</Steps>
+
 ## Script-based DReps
 
+<Steps>
+
 Lucid Evolution supports script-based DReps, allowing for programmatic voting behavior
 
-#### Register Script DRep
+### Register Script DRep
 
 ```typescript
 await lucid
@@ -138,14 +158,16 @@ await lucid
   .attach.Script(script)
 ```
 
-#### Deregister Script DRep
+### Deregister Script DRep
 
 ```typescript
 await lucid
   .newTx()
   .deregister.DRep(rewardAddress)
 ```
 
+</Steps>
+
 ## Example
 
 To utilize these methods, you need to initiate the `TxBuilder` configuration by calling `newTx()` after `Lucid` is initialized

docs/pages/index.mdx

@@ -92,13 +92,13 @@ Why <span style={{ color: '#8b0000' }}>Evolution</span>?
 
 <div style={{ marginBottom: "6rem" }}></div>
 
-# Quickstart
+# <span style={{color: '#AD1F1E'}}>Quickstart</span>
 
 ---
 
 <Steps>
 ### Set up your project
-Initialize a new TypeScript project
+Initialize a new `TypeScript` project
 
 ### Install the packages you need
 
@@ -111,15 +111,15 @@ Initialize a new TypeScript project
 ---
 
 <Steps>
-→ **Instantiate Lucid Evolution** and choose a provider
+<span style={{color: '#AD1F1E'}}>→</span> **Instantiate** **<span style={{color: '#AD1F1E'}}>Lucid Evolution</span>** and choose a provider
 <Cards>
   <Cards.Card
     title = "Core Concept 1: Instantiation"
     href = "/documentation/core-concepts/instantiate-evolution"
   />
 </Cards>
 
-→ **Choose a wallet** and select it
+<span style={{color: '#AD1F1E'}}>→</span>  **<span style={{color: '#AD1F1E'}}>Choose</span>** **a wallet** and select it
 
 <Cards>
   <Cards.Card
@@ -128,7 +128,7 @@ Initialize a new TypeScript project
   />
 </Cards>
 
-→ **Build your first transaction** and submit it
+<span style={{color: '#AD1F1E'}}>→</span>  **Build your <span style={{color: '#AD1F1E'}}>first transaction</span>** and submit it
 
 <Cards>
   <Cards.Card
@@ -137,7 +137,7 @@ Initialize a new TypeScript project
   />
 </Cards>
 
-→ **Learn more** about advanced concepts and start building
+<span style={{color: '#AD1F1E'}}>→</span> **<span style={{color: '#AD1F1E'}}>Learn more</span>** about advanced concepts and start building
 
 <Cards>
   <Cards.Card
@@ -151,7 +151,7 @@ Initialize a new TypeScript project
 
 <div style={{ marginBottom: "6rem" }}></div>
 
-# F.A.Q.
+# <span style={{color: '#AD1F1E'}}>F.A.Q.</span>
 
 ---
 

docs/pages/showcase.mdx

@@ -0,0 +1,44 @@
+import { Cards } from 'nextra/components'
+
+# Powered by Lucid<span style={{color: '#8b0000'}}> Evolution</span>
+---
+
+<Cards>
+  <ShowcaseCard title="Mynth" href="https://www.mynth.ai" style={{ width: '200px', height: '250px' }}>
+    <>![Mynth](https://avatars.githubusercontent.com/u/131367296?s=200&v=4)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="Pondora" href="https://pondora.org" style={{ width: '200px', height: '250px' }}>
+    <>![Pondora](https://avatars.githubusercontent.com/u/159527663?s=200&v=4)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="Genius Yield" href="https://www.geniusyield.co" style={{ width: '200px', height: '250px' }}>
+    <>![Genius Yield](https://avatars.githubusercontent.com/u/86468066?s=200&v=4)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="Splash" href="https://www.splash.trade" style={{ width: '200px', height: '250px' }}>
+    <>![Splash](https://avatars.githubusercontent.com/u/150360075?s=200&v=4)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="ADA Markets" href="https://ada.markets" style={{ width: '200px', height: '250px' }}>
+    <>![ADA Markets](https://app.ada.markets/assets/images/ADAmarkets.png)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="MELD" href="https://www.meld.com" style={{ width: '200px', height: '250px' }}>
+    <>![MELD](https://avatars.githubusercontent.com/u/53253566?s=200&v=4)</>
+  </ShowcaseCard>
+  <ShowcaseCard title="Summon" href="https://summonplatform.io" style={{ width: '200px', height: '250px' }}>
+    <>![Summon Platform](https://summonplatform.io/wp-content/uploads/2022/07/Summon-Token-2048x2048.png)</>
+  </ShowcaseCard>
+</Cards>
+
+# Let us know!
+---
+Are you building an open-source project with Lucid Evolution? We'd love to feature you here!
+
+export const ShowcaseCard = Object.assign(
+  Cards.Card.bind(),
+  {
+    displayName: 'ShowcaseCard',
+    defaultProps: {
+      image: true,
+      arrow: true,
+      target: '_blank'
+    }
+  }
+)

docs/theme.config.jsx

@@ -19,7 +19,7 @@ export default {
       title: "Lucid Evolution - Welcome",
     };
   },
-
+  
   primaryHue: 0,
   primarySaturation: 90,
   logo: () => (