Skip to content

Commit

Permalink
show category pages for how-to guides in sidebar (#704)
Browse files Browse the repository at this point in the history
* show category pages for how-to guides in sidebar

* mark the two empty category pages as drafts
  • Loading branch information
ElliotFriend authored Jun 20, 2024
1 parent 224afb1 commit f2389f3
Show file tree
Hide file tree
Showing 25 changed files with 48 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/smart-contracts/guides/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: How-To Guides
description: here you will find really useful guides
sidebar_position: 35
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

The page lists all guides we have available for Soroban. Simply put, a "guide" is a short, bite-sized example that details how to accomplish a specific task. These guides are focused on a single topic, and are limited in scope.
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/archival/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: State Archival
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

Soroban's novel strategy to combat state bloat can present a learning curve for developers. Here are some quick guides that will help you through the process.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/cli/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Stellar CLI
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

The [Stellar CLI] is a crucial tool for developers to use while creating and interacting with Stellar smart contracts.
Expand Down
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/conventions/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Conventions
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

These guides describe the "typical" way something might be accomplished in a Rust contract. These guides aren't meant to be quite as _prescriptive_ as some others; instead, they serve to highlight some of the norms we've seen when crop up in contract development.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/conventions/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
2 changes: 2 additions & 0 deletions docs/smart-contracts/guides/conversions/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Type Conversions
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
draft: true
---

A collection of guides for converting from one data type to another in a variety of SDK languages.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/conversions/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
2 changes: 2 additions & 0 deletions docs/smart-contracts/guides/dapps/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Dapp Development
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

We've written some helpful guides on some of the most useful tools available to you, the dapp developer.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/dapps/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/events/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Events
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

Learn how to emit, ingest, and use events published from a Soroban smart contract.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/events/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
2 changes: 2 additions & 0 deletions docs/smart-contracts/guides/fees/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Fees & Metering
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
draft: true
---

Fees and metering in Soroban smart contracts work differently than the fees for "regular" Stellar transactions. The Stellar network still provides cheap, accessible transaction and that now includes smart contract metering!
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/fees/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/freighter/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Freighter Wallet
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

[Freighter](https://www.freighter.app/) is a browser extension wallet provided by the Stellar Development Foundation. It provides users a way to interact with Soroban tokens directly from the web browser.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/freighter/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/rpc/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: RPC
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

Using and interacting with Soroban RPC is an important part of the smart contract development lifecycle.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/rpc/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/storage/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Storage
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

Soroban storage is available to affordably accommodate a wide range of uses.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/storage/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/testing/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Testing
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

Smart contract testing is vital to ensure safe, resilient, and accurate computation.
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/testing/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}
1 change: 1 addition & 0 deletions docs/smart-contracts/guides/transactions/README.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Transactions
hide_table_of_contents: true
sidebar_class_name: sidebar-category-items-hidden
---

The entry point for every smart contract interaction is ultimately a [transaction] on the Stellar network.
Expand Down
3 changes: 3 additions & 0 deletions docs/smart-contracts/guides/transactions/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"collapsible": false
}

0 comments on commit f2389f3

Please sign in to comment.