Skip to content
Draft
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ dist/
build/

# --- allow SDK docs build/ dirs (override rule above) ---
!sdk/next/build/
!sdk/next/build/**
!sdk/v0.53/build/
!sdk/v0.53/build/**
!sdk/v0.50/build/
Expand Down
70 changes: 69 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,72 @@ When updating documentation:
- Navigation structure must be updated in `docs.json` when adding new pages
- Interactive RPC documentation is generated from the source `methods.mdx` file
- Test findings in `tests/README.md` track documentation accuracy against implementation
- Use relative imports for snippets and components (e.g., `/snippets/icons.mdx`)
- Use relative imports for snippets and components (e.g., `/snippets/icons.mdx`)

## Documentation Style Guide

### Writing Standards

When writing or updating documentation, follow these style guidelines:

- No bold text
- No italics
- No first person pronouns (I, we, us, our)
- Be concise and direct
- Write naturally, as a human would
- No horizontal line breaks (---)
- No emojis
- Use paragraphs where appropriate for readability
- Use unordered lists only where they improve clarity
- Use ordered lists only for sequential steps or ranked items
- Be clear, concise, and coherent

### Mintlify Syntax

The documentation uses Mintlify-specific MDX components. Use these components appropriately:

**Callouts**: Use sparingly and only where they add value. Available types:
```mdx
<Note>General information or tips</Note>
<Info>Informational content</Info>
<Warning>Important warnings or cautions</Warning>
<Tip>Helpful tips or best practices</Tip>
<Check>Success messages or confirmations</Check>
```

**Code Blocks**: Always specify the language for syntax highlighting:
```mdx
```javascript
const example = "code";
```
```

**Tabs**: For showing multiple options or examples:
```mdx
<Tabs>
<Tab title="JavaScript">
Content for JavaScript
</Tab>
<Tab title="Python">
Content for Python
</Tab>
</Tabs>
```

**Accordions**: For collapsible content sections:
```mdx
<Accordion title="Click to expand">
Hidden content here
</Accordion>
```

**Cards**: For grouped navigation or features:
```mdx
<CardGroup cols={2}>
<Card title="Title" icon="icon-name" href="/path">
Description
</Card>
</CardGroup>
```

Use these components only where appropriate. Do not overuse callouts or formatting that may distract from the technical content.
27 changes: 27 additions & 0 deletions sdk/next/build.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Overview"
description: "Version: v0.53"
---

Learn how to build a complete blockchain application using the Cosmos SDK. This section covers everything from creating your chain's core application logic to implementing advanced features like vote extensions and ABCI customization.

<CardGroup cols={2}>
<Card title="Chain Development" icon="code" href="/sdk/v0.53/build/building-apps/app-go">
Build your blockchain application with guides on app.go setup, dependency injection, mempool configuration, and vote extensions.
</Card>
<Card title="SDK Packages" icon="package" href="/sdk/v0.53/build/packages">
Leverage powerful SDK packages including depinject for dependency injection and collections for state management.
</Card>
<Card title="Building Transactions" icon="file-contract" href="/sdk/v0.53/tutorials/transactions/building-a-transaction">
Learn how to programmatically create, sign, and broadcast transactions in your application.
</Card>
<Card title="Simulation Testing" icon="vial" href="/sdk/v0.53/learn/advanced/simulation">
Test your chain with fuzz testing and simulation frameworks to ensure robustness and catch edge cases.
</Card>
<Card title="ABCI" icon="repeat" href="/sdk/v0.53/build/abci/introduction">
Customize blockchain behavior with ABCI methods including PrepareProposal, ProcessProposal, and vote extensions.
</Card>
<Card title="Build a Module" icon="box" href="/sdk/v0.53/build/building-modules/intro">
Develop custom modules with comprehensive guides on module architecture, message handling, and state management.
</Card>
</CardGroup>
Loading