Skip to content

Commit

Permalink
add top level sidebar dropdown for cli commands
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanwaits committed Nov 12, 2024
1 parent c49ee2e commit b97e1c1
Show file tree
Hide file tree
Showing 11 changed files with 67 additions and 309 deletions.
1 change: 0 additions & 1 deletion content/docs/stacks/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ If you're looking for direct access to the Stacks node, including the ability to
title="Get data from a block"
description="Retrieves a block by its height or hash."
/>

</Cards>

## Related tools
Expand Down
300 changes: 0 additions & 300 deletions content/docs/stacks/clarinet/guides/cli-commands.mdx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Deploy a contract
description: Use Clarinet to publish your contracts to the devnet, testnet, or mainnet networks.
---

import { File, Folder, Files } from 'fumadocs-ui/components/files';
import {
Tooltip,
TooltipContent,
Expand All @@ -17,6 +16,27 @@ The first step to deploying your contracts is to generate a deployment plan.
$ clarinet deployment generate --testnet
```

```yaml deployments/default.testnet-plan.yaml
---
id: 0
name: Testnet deployment
network: testnet
stacks-node: "http://localhost:20443"
bitcoin-node: "http://devnet:devnet@localhost:18443"
plan:
batches:
- id: 0
transactions:
- contract-publish:
contract-name: counter
expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
cost: 6940
path: contracts/counter.clar
anchor-block-only: true
clarity-version: 2
epoch: "2.5"
```
<Callout title="What are deployment plans?" type="info">
These are `yaml` files for creating reproducible deployment steps that publish a collection of on-chain transactions and contracts to a <TooltipProvider inline><Tooltip><TooltipTrigger asChild><span className='cursor-default border-b border-dotted border-primary text-primary'>network</span></TooltipTrigger><TooltipContent>Available network flags are `--devnet`, `--testnet`, and `--mainnet`</TooltipContent></Tooltip></TooltipProvider>.
</Callout>
Expand Down
34 changes: 34 additions & 0 deletions content/docs/stacks/clarinet/guides/cli-commands/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: CLI commands
description: A comprehensive list of all Clarinet CLI commands and their usage.
---

import { SecondaryCard } from '@/components/card';

<Cards>
<SecondaryCard
href="/stacks/clarinet/guides/cli-commands/create-a-new-project"
title="Create a new project"
description="Create a new Clarinet project."
/>
<SecondaryCard
href="/stacks/clarinet/guides/cli-commands/add-a-contract"
title="Add a contract"
description="Add a contract to your project."
/>
<SecondaryCard
href="/stacks/clarinet/guides/cli-commands/validate-a-contract"
title="Validate a contract"
description="Validate a contract in your project."
/>
<SecondaryCard
href="/stacks/clarinet/guides/cli-commands/run-a-local-devnet"
title="Run a local devnet"
description="Run a local devnet."
/>
<SecondaryCard
href="/stacks/clarinet/guides/cli-commands/deploy-a-contract"
title="Deploy a contract"
description="Deploy a contract."
/>
</Cards>
10 changes: 10 additions & 0 deletions content/docs/stacks/clarinet/guides/cli-commands/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"title": "CLI commands",
"pages": [
"create-a-new-project",
"add-a-contract",
"validate-a-contract",
"run-a-local-devnet",
"deploy-a-contract"
]
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Customizing deployment plans
title: Customize deployment plans
description: Learn how to customize your deployment plans.
---

Expand Down
Loading

0 comments on commit b97e1c1

Please sign in to comment.