Skip to content
Open
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
61 changes: 61 additions & 0 deletions docs/getting-started/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Getting Started with Xode

This guide will help you get started with the Xode blockchain, whether you're a developer, validator, or user.

## Prerequisites

Before you begin, ensure you have the following installed:

- [Rust](https://www.rust-lang.org/tools/install) (latest stable version)
- [Git](https://git-scm.com/downloads)
- [Docker](https://docs.docker.com/get-docker/) (optional, for containerized setup)

## System Requirements

- **OS**: Linux, macOS, or Windows (via WSL2)
- **Memory**: Minimum 4GB RAM (8GB recommended)
- **Storage**: 20GB free space
- **Network**: Stable internet connection

## Installation

### Clone the Repository

```bash
git clone https://github.com/Xode-DAO/xode-blockchain.git
cd xode-blockchain
```

### Build the Node

```bash
cargo build --release
```

This will compile the Xode node binary. The build process may take 10-30 minutes depending on your hardware.

## Running a Local Node

### Start a Development Node

```bash
./target/release/xode-node --dev
```

The node will start with:
- Pre-funded development accounts
- Instant block production
- WebSocket RPC at `ws://127.0.0.1:9944`
- HTTP RPC at `http://127.0.0.1:9933`

### Connect to Testnet

```bash
./target/release/xode-node --chain=testnet
```

## Next Steps

- [Quick Start Guide](quickstart.md)
- [Architecture Overview](../architecture/overview.md)
- [Development Setup](../development/setup.md)
31 changes: 31 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Xode Blockchain Documentation

Welcome to the official Xode Blockchain documentation! This guide provides comprehensive information for developers, validators, and contributors participating in the Xode ecosystem.

## What is Xode?

Xode is a next-generation blockchain built on Substrate, designed for enterprise-grade applications with a focus on scalability, security, and developer experience.

## Key Features

- **Substrate-based**: Built on the modular blockchain framework that powers Polkadot
- **Enterprise-ready**: Designed for real-world business applications
- **Developer-friendly**: Comprehensive tooling and SDKs
- **Governance-focused**: On-chain governance for community-driven evolution

## Quick Links

- [Getting Started](getting-started/overview.md) - Learn the basics
- [Architecture](architecture/overview.md) - Understand the system design
- [Pallets](pallets/overview.md) - Explore runtime modules
- [Development](development/setup.md) - Contribute to the codebase

## Getting Help

- Join our [Discord community](https://discord.gg/xode)
- Open an [issue on GitHub](https://github.com/Xode-DAO/xode-blockchain/issues)
- Read the [FAQ](community/faq.md)

## License

This project is licensed under the Apache-2.0 License.
83 changes: 83 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
site_name: Xode Blockchain Documentation
site_description: Developer documentation for Xode blockchain
site_url: https://xode-dao.github.io/xode-blockchain

repo_name: Xode-DAO/xode-blockchain
repo_url: https://github.com/Xode-DAO/xode-blockchain
edit_uri: edit/main/docs/

theme:
name: material
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.highlight
- content.code.copy
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode

plugins:
- search
- minify:
minify_html: true

markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- pymdownx.mark
- admonition
- toc:
permalink: true

nav:
- Home: index.md
- Getting Started:
- Overview: getting-started/overview.md
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Architecture:
- Overview: architecture/overview.md
- Node: architecture/node.md
- Runtime: architecture/runtime.md
- Pallets:
- Overview: pallets/overview.md
- Staking: pallets/staking.md
- Development:
- Setup: development/setup.md
- Testing: development/testing.md
- Contributing: development/contributing.md
- API Reference:
- RPC: api/rpc.md
- Extrinsics: api/extrinsics.md
- Governance:
- Overview: governance/overview.md
- Proposal Process: governance/proposals.md
- Community:
- Resources: community/resources.md
- FAQ: community/faq.md

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Xode-DAO