Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add callouts for platform api #789

Merged
merged 1 commit into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/(docs)/[...slug]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ export default function Page({ params }: { params: Param }): JSX.Element {
] || secondSegment.charAt(0).toUpperCase() + secondSegment.slice(1));
}

if (page.slugs[1].toLowerCase() === "platform-api") {
prefix = "Platform API";
}

if (page.slugs[1].toLowerCase() === "token-metadata-api") {
prefix = "Token Metadata API";
}
Expand Down
4 changes: 4 additions & 0 deletions content/docs/stacks/platform/guides/create-chainhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description: Create a chainhook using the Hiro Platform.

With Chainhook, you can automatically trigger an action in response to on-chain events on Stacks and Bitcoin, enabling you to use IFTTT (if_this, then_that) logic to power your applications. To learn more about Chainhook, refer to the [Chainhook overview](/stacks/chainhook).

<Callout title="Programmatic API">
You can also create and manage chainhooks via the [Platform API](/stacks/platform-api/chainhooks).
</Callout>

To get started in the Hiro Platform, login and toggle to the Chainhook page. There are two ways to create a chainhook. You can either create a chainhook from scratch using the platform UI, or you can upload chainhooks that you have already defined in JSON.

![Create Chainhook Window](../images/chainhook/select-chainhook-tab.png)
Expand Down
4 changes: 4 additions & 0 deletions content/docs/stacks/platform/guides/devnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ In the top right corner of your project page, you'll notice a devnet status indi

![Start Devnet](../images/devnet/start.png)

<Callout title="Programmatic API">
You can also start and stop devnet programmatically via the [Platform API](/stacks/platform-api/devnet).
</Callout>

If you want to configure your devnet (like you can locally using `clarinet devnet start` in the terminal), open your project's `devnet.toml` file in the platform VS Code editor before you start devnet. From there, you can configure the settings to match your development needs.

Once you start devnet, it will take a few moments to spin up. The status indicator on the project dashboard will keep you updated on the progress.
Expand Down
Loading