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
237 changes: 237 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
# Contributing to Xode Documentation

Thank you for your interest in improving Xode's documentation! This guide will help you make high-quality contributions.

## 🎯 Quick Start

1. Fork the repository
2. Clone your fork locally
3. Create a branch: `git checkout -b docs/your-improvement`
4. Make changes and test locally with `npm start`
5. Build to verify: `npm run build`
6. Submit a Pull Request

## πŸ“‹ Contribution Types

### Documentation Updates
- Fix typos, grammar, or formatting
- Update outdated information
- Improve clarity and readability
- Add missing details

### New Content
- Tutorials and guides
- Code examples
- Architecture diagrams
- API references

### Technical Improvements
- Better code samples
- Performance optimizations
- Accessibility enhancements
- SEO improvements

## ✍️ Writing Style

### Voice and Tone
- **Clear and concise**: Avoid unnecessary jargon
- **Helpful and friendly**: Write for developers of all levels
- **Accurate and precise**: Verify all technical details
- **Consistent**: Follow existing patterns

### Formatting Standards

#### Headings
```markdown
# Page Title (H1 - only one per page)
## Major Section (H2)
### Subsection (H3)
#### Minor Point (H4)
```

#### Code Blocks
Always specify the language:

```rust
// Rust example
#[ink::contract]
mod flipper {
// ...
}
```

```bash
# Bash commands
npm install
npm start
```

#### Admonitions
Use admonitions to highlight important information:

```markdown
:::tip
This is helpful advice!
:::

:::warning
Be careful with this operation.
:::

:::info
Additional context or background.
:::

:::danger
Critical warning about breaking changes.
:::
```

#### Links
- Use descriptive link text: `[Polkadot documentation](https://docs.polkadot.com)`
- Not: `Click [here](https://example.com)`
- Internal links: `[Getting Started](../getting-started/overview.md)`

#### Tables
```markdown
| Feature | Description | Status |
|---------|-------------|--------|
| ink! | Wasm contracts | βœ… Live |
| EVM | Solidity support | 🚧 Planned |
```

## πŸ“ Frontmatter

Every page must include frontmatter:

```markdown
---
title: Page Title
sidebar_position: 1
description: Brief description for SEO and previews
---
```

## 🎨 Mermaid Diagrams

Use Mermaid for architecture diagrams:

```mermaid
graph TD
A[Relay Chain] --> B[Parachain 3344]
A --> C[Parachain 3417]
B --> D[Collators]
C --> E[Validators]
```

**Best Practices:**
- Keep diagrams simple and focused
- Use consistent styling
- Add labels for clarity
- Test rendering locally

## πŸ§ͺ Testing Your Changes

### Local Testing
```bash
# Install dependencies
npm install

# Start development server
npm start

# Build production version
npm run build

# Serve built site
npm run serve
```

### Pre-submission Checklist
- [ ] All links work correctly
- [ ] Code examples run without errors
- [ ] Mermaid diagrams render properly
- [ ] No spelling or grammar errors
- [ ] Frontmatter is complete
- [ ] Build completes successfully
- [ ] Content is accurate and up-to-date

## πŸ” Review Process

### What We Look For
1. **Accuracy**: Is the information correct?
2. **Completeness**: Does it cover the topic adequately?
3. **Clarity**: Is it easy to understand?
4. **Consistency**: Does it match our style?
5. **Quality**: Are examples working and well-explained?

### Response Times
- Small fixes (typos, links): 1-2 days
- Content updates: 3-5 days
- New pages: 5-7 days
- Major restructuring: 1-2 weeks

## 🚫 Common Mistakes

### ❌ Don't
- Copy content from other sources without attribution
- Include promotional material
- Add unverified information
- Break existing links
- Ignore build errors
- Use vague language like "easy" or "simply"

### βœ… Do
- Verify technical details
- Test all code examples
- Update related pages
- Check for broken links
- Follow the style guide
- Be specific and concrete

## πŸ“š Resources

### Docusaurus
- [Official Documentation](https://docusaurus.io/docs)
- [Markdown Features](https://docusaurus.io/docs/markdown-features)
- [Mermaid Diagrams](https://docusaurus.io/docs/markdown-features/diagrams)

### Substrate & Polkadot
- [Substrate Docs](https://docs.substrate.io/)
- [Polkadot Wiki](https://wiki.polkadot.network/)
- [ink! Documentation](https://use.ink/)

### Writing
- [Google Developer Style Guide](https://developers.google.com/style)
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/)

## πŸ† Recognition

Contributors will be:
- Listed in our contributors page
- Mentioned in release notes
- Eligible for community rewards
- Invited to special events

## πŸ“§ Questions?

- **Documentation issues**: Open a GitHub issue
- **General questions**: Ask in Telegram
- **Development help**: Join our Discord
- **Email**: docs@xode.net

## πŸ“œ Code of Conduct

We follow the [Contributor Covenant](https://www.contributor-covenant.org/). Please be:
- Respectful and inclusive
- Constructive in feedback
- Patient with newcomers
- Professional in communication

## πŸŽ‰ Thank You!

Every contribution, no matter how small, helps make Xode better for everyone. We appreciate your time and effort!

---

**Happy documenting! πŸ“**
160 changes: 160 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Xode Blockchain Documentation

Welcome to the official documentation repository for **Xode Blockchain** β€” a Polkadot and Kusama parachain focused on smart contracts, DeFi, and Web3 infrastructure.

## πŸš€ About Xode

Xode is a next-generation blockchain built on Substrate, operating as a parachain on both Polkadot and Kusama networks. Our mission is to provide developers and users with a secure, scalable, and interoperable platform for decentralized applications.

**Key Features:**
- **Dual Parachain**: Deployed on both Kusama (ID: 3344) and Polkadot (ID: 3417)
- **Smart Contracts**: ink! support with future EVM compatibility
- **Asset Hub**: Native multi-asset support via pallet-assets
- **Proof-of-Stake**: 4% annual staking rewards
- **Governance**: Treasury Council & Technical Committee
- **Audited**: CertiK AA rating

## πŸ“– Documentation

This documentation is built with [Docusaurus 3](https://docusaurus.io/) and covers:

- **Getting Started**: Wallets, RPC endpoints, and basic setup
- **Network Architecture**: Parachain design, collators, validators, and relay chain integration
- **Development**: Smart contract development, node setup, pallets, and runtime
- **Tokenomics**: XON token distribution, staking, and burn schedule
- **Governance**: DAO structure, treasury, and OpenGov roadmap
- **Ecosystem**: Block scanner, exchanges, DeFi integrations, and partners

## πŸ› οΈ Contributing

We welcome contributions from the community! Here's how you can help:

### Prerequisites

- Node.js 18+ and npm
- Git
- Basic knowledge of Markdown

### Local Development

1. **Clone the repository**
```bash
git clone https://github.com/Xode-DAO/xode-blockchain.git
cd xode-blockchain/docs
```

2. **Install dependencies**
```bash
npm install
```

3. **Start the development server**
```bash
npm start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

4. **Build for production**
```bash
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Making Changes

1. **Fork the repository** on GitHub
2. **Create a new branch** for your changes
```bash
git checkout -b docs/your-feature-name
```
3. **Make your changes** following our style guide
4. **Test locally** with `npm start`
5. **Build to verify** with `npm run build`
6. **Commit your changes** with a descriptive message
```bash
git commit -m "docs: add tutorial for XCM integration"
```
7. **Push to your fork** and create a Pull Request

### Style Guide

- Use clear, concise language
- Include code examples where appropriate
- Add Mermaid diagrams for complex concepts
- Use admonitions (:::tip, :::warning, :::info) to highlight important information
- Include proper frontmatter with title, sidebar_position, and description
- Verify all links work before submitting

### Documentation Structure

```
docs/
β”œβ”€β”€ intro.md
β”œβ”€β”€ getting-started/
β”œβ”€β”€ network/
β”œβ”€β”€ development/
β”œβ”€β”€ tokenomics/
β”œβ”€β”€ governance/
└── ecosystem/
```

Each section should:
- Have a clear purpose and audience
- Include practical examples
- Link to related pages
- Be kept up-to-date with network changes

## πŸ“ Content Guidelines

### What to Include

βœ… **Accurate technical information** from official sources
βœ… **Step-by-step tutorials** for common tasks
βœ… **Code examples** with explanations
βœ… **Architecture diagrams** using Mermaid
βœ… **Links to external resources** (GitHub, explorers, wallets)
βœ… **Updates** as the network evolves

### What to Avoid

❌ Outdated information
❌ Promotional language
❌ Unverified claims
❌ Broken links
❌ Duplicate content

## πŸ› Reporting Issues

Found a problem with the documentation? Please [open an issue](https://github.com/Xode-DAO/xode-blockchain/issues) with:

- Clear description of the problem
- Page URL or file path
- Suggested correction (if applicable)
- Screenshots (if relevant)

## πŸ“œ License

This documentation is licensed under [MIT License](LICENSE).

## πŸ”— Links

- **Website**: [xode.net](https://xode.net)
- **Block Scanner**: [node.xode.net](https://node.xode.net)
- **GitHub**: [github.com/Xode-DAO](https://github.com/Xode-DAO)
- **Telegram**: [t.me/xodenetwork](https://t.me/xodenetwork)
- **Twitter**: [twitter.com/xodenetwork](https://twitter.com/xodenetwork)

## πŸ’¬ Get Help

Need assistance? Reach out through:

- GitHub Issues for documentation problems
- Telegram community for general questions
- Discord for developer discussions
- Email: support@xode.net

---

**Built with ❀️ by the Xode community**
Loading