https://github.com/neutron-org/neutron-docs
https://github.com/neutron-org/neutron-docs
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/neutron-org/neutron-docs
- Owner: neutron-org
- Created: 2022-07-14T06:55:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-05T21:56:30.000Z (11 months ago)
- Last Synced: 2025-09-05T23:38:08.384Z (11 months ago)
- Language: MDX
- Size: 120 MB
- Stars: 21
- Watchers: 7
- Forks: 41
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - neutron-org/neutron-docs - (MDX)
README
# Neutron Documentation
The comprehensive documentation hub for the Neutron blockchain - the first Consumer Chain of the Cosmos Hub. This repository contains detailed guides, tutorials, and references for developers, validators, and users of the Neutron ecosystem.
## 🌟 What is Neutron?
Neutron is a permissionless smart contract platform that leverages Interchain Security (ICS) from Cosmos Hub, enabling secure cross-chain DeFi applications with native integrations to 50+ Cosmos chains and beyond.
## 📖 Documentation Structure
### 🏠 **Home & Core Concepts**
- **Introduction & Quickstart**: Get started with Neutron basics
- **Integrated Architecture**: Understanding Neutron's unique Consumer Chain design
- **Opinionated Blockchains**: How Neutron enables focused blockchain applications
- **Proof of Liquid Staking**: Neutron's innovative consensus and security model
- **Modular Governance**: Decentralized decision-making mechanisms
- **Tokenomics**: NTRN token economics and utility
### 💹 **DeFi Ecosystem**
- **DeFi Overview**: Complete landscape of Neutron's financial applications
- **Featured Protocols**: Duality, SuperVaults, Bull vs Bear, Drop Staking
- **Integration Guides**: How to connect with Neutron's DeFi infrastructure
### 👨💻 **Developer Resources**
- **Getting Started**: Developer onboarding and environment setup
- **SDK & Tools**: Neutron Template, BullBear integration, boilerplates
- **Comprehensive Tutorials**:
- CosmWasm smart contract development
- Interchain Accounts (ICA) and Queries (ICQ)
- Integration testing and deployment
- Indexing and data analysis
- **Modules Documentation**: Deep dives into Neutron's custom modules
- **API Reference**: Complete technical specifications
### 🔒 **Validator Operations**
- **Overview**: Complete validator ecosystem and requirements
- **Node Setup**: Comprehensive guide for running Neutron nodes
- **Becoming a Validator**: Step-by-step validator registration process
- **Oracle Operations**: Slinky oracle setup and maintenance
- **Economics**: Validator incentives, rewards, and performance metrics
- **Security**: Best practices and operational guidelines
## 🛠 Development
This documentation is built with [Mintlify](https://mintlify.com), a modern documentation platform designed for developer-focused content.
### Local Development
1. **Install Mintlify CLI**:
```bash
npm i -g mintlify
```
2. **Preview documentation locally**:
```bash
mintlify dev
```
3. **Install dependencies** (if needed):
```bash
mintlify install
```
### Publishing Changes
Documentation is automatically deployed when changes are pushed to the default branch. For more information about Mintlify's deployment process, visit the [Mintlify documentation](https://mintlify.com/docs).
### Troubleshooting
- **Mintlify dev isn't running**: Run `mintlify install` to re-install dependencies
- **Page loads as a 404**: Make sure you are running in a folder with `docs.json`
- **Build errors**: Check the [Mintlify troubleshooting guide](https://mintlify.com/docs/troubleshooting)
### Key Features
- 🎨 **Beautiful Design**: Modern, responsive interface with dark/light modes
- 🔍 **Advanced Search**: Full-text search across all documentation
- 📱 **Mobile Optimized**: Perfect experience on all devices
- 🔗 **Deep Linking**: Direct links to specific sections and code blocks
- 💻 **Code Examples**: Interactive code samples and tutorials
- 🌐 **Multi-format Support**: MDX, API references, and rich media
## 🌐 Community & Resources
### Official Links
- **Website**: [neutron.org](https://neutron.org)
- **App**: [app.neutron.org](https://app.neutron.org)
- **GitHub**: [github.com/neutron-org](https://github.com/neutron-org)
### Community
- **Discord**: [Join our community](https://discord.com/invite/bzPBzbDvWC)
- **Twitter**: [@neutron_org](https://twitter.com/neutron_org)
- **Forum**: [Neutron Governance](https://forum.neutron.org)
## 📊 Repository Statistics
- **Comprehensive Coverage**: 100+ documentation pages
- **Multi-audience**: Developers, validators, and end users
- **Active Maintenance**: Regular updates with protocol developments
- **Community Driven**: Open source with community contributions
## 📝 License
This documentation is open source and available under the [MIT License](LICENSE).
---
*Neutron: Secure, interoperable, and developer-friendly blockchain infrastructure for the next generation of DeFi.*