📝 update docs

marigold-dev · Dec 8, 2023 · 1e2afe7 · 1e2afe7
1 parent 910310d
commit 1e2afe7
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 11 deletions.
diff --git a/docs/book.toml b/docs/book.toml
@@ -1,6 +1,25 @@
 [book]
-authors = ["Quentin Burg"]
+authors = ["Marigold.dev"]
 language = "en"
 multilingual = false
 src = "src"
-title = "book"
+title = "Gas Station Documentation"
+
+[output.html]
+mathjax-support = true
+additional-css = ["marigold-docs-theme/marigold.css"]
+additional-js = ["marigold-docs-theme/marigold.js"]
+git-repository-url = "https://github.com/marigold-dev/gas-station"
+
+[output.html.playground]
+editable = true
+line-numbers = true
+
+[output.html.search]
+limit-results = 20
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 2
+boost-paragraph = 1
+expand = true
+heading-split-level = 2
diff --git a/docs/src/README.md b/docs/src/README.md
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,7 +1,7 @@
 # Summary
 
-[Welcome](./WELCOME.md)
-[Gas Station Webapp](./WEBAPP.md)
-[SDKs](./LIBRARY.md)
-[API](./API.md)
-[Tutorial](./TUTORIAL.md)
+[Welcome](./welcome.md)
+[Gas Station Webapp](./webapp.md)
+[SDKs](./library.md)
+[API](./api.md)
+[Tutorial](./tutorial.md)
diff --git a/docs/src/TUTORIAL.md b/docs/src/TUTORIAL.md
@@ -20,7 +20,7 @@ The files of interest are located in `src/lib`. You will find Svelte components
 ## Minting
 
 We'll start with minting an NFT by a user. The contract we'll use is available at this address on Ghostnet: `KT199yuNkHQKpy331A6fvWJtQ1uan9uya2jx`.
-The goal here is for the user to initiate the mint action and retrieve their NFT without having to pay gas fees. For this, we will use the TypeScript SDK, and you can find more information [here](./LIBRARY.md).
+The goal here is for the user to initiate the mint action and retrieve their NFT without having to pay gas fees. For this, we will use the TypeScript SDK, and you can find more information [here](./library.md).
 
 First, we'll setup the GasStation SDK as follows:
 ```ts
@@ -71,7 +71,7 @@ If an error occurs (insufficient funds, authorization issue for minting the NFT,
 
 For staking, we need a permit. Staking involves transferring our freshly minted NFT to the contract. As we own the NFT, it is appropriate to sign a permit (authorization) to perform this transfer.
 
-To facilitate the development of this new feature, we will also use the TypeScript SDK (for reference, you have all the information [here](./LIBRARY.md))
+To facilitate the development of this new feature, we will also use the TypeScript SDK (for reference, you have all the information [here](./library.md))
 
 To start, let's initialize the `GasStation` and `PermitContract`  classes from the SDK:
 ```ts

diff --git a/docs/src/WEBAPP.md b/docs/src/WEBAPP.md
@@ -38,4 +38,4 @@ You can also withdraw XTZ from your vault. On the `My credits` page, enter the a
 
 ### Test
 
-Once the contract is added and credits are transferred to your vault, you can integrate the Gas Station into your dApps by following this [guide](./TUTORIAL.md). This will allow you to test the seamless integration of the Gas Station with your dApps.
+Once the contract is added and credits are transferred to your vault, you can integrate the Gas Station into your dApps by following this [guide](./tutorial.md). This will allow you to test the seamless integration of the Gas Station with your dApps.