Skip to content

Repository files navigation

TeQoin Documentation

Official documentation for TeQoin(Testnet) - EVM Layer-2 Scaling with Low-Fee Optimistic Rollup

Documentation License Mintlify

🌐 Live Documentation

Visit our documentation at docs.teqoin.io

📖 About This Repository

This repository contains the complete source code for TeQoin's technical documentation, built with Mintlify. Our documentation covers:

  • 🚀 Quick Start Guides - Get started with TeQoin in minutes
  • 💻 Developer Documentation - Build on TeQoin L2
  • 🌉 Bridge Guides - Move assets between L1 and L2
  • 🏗️ Architecture - Technical deep dives
  • 📚 Tutorials - Step-by-step guides
  • 🛠️ API Reference - Complete API documentation

🏗️ Repository Structure

docs/
├── introduction/          # What is TeQoin, why use it
├── quickstart/           # Getting started guides
├── developers/           # Developer documentation
├── bridge/              # L1 ↔ L2 bridge documentation
├── architecture/        # Technical architecture docs
├── tutorials/           # Step-by-step tutorials
├── resources/           # Additional resources
└── mint.json            # Mintlify configuration

🚀 Local Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/TeQoin/docs.git
cd docs

# Install Mintlify CLI
npm i -g mintlify

# Start development server
mintlify dev

Open http://localhost:3000

📝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Quick Start for Contributors

# Fork and clone
git clone https://github.com/YOUR_USERNAME/docs.git

# Create feature branch
git checkout -b feature/your-feature

# Make changes and commit
git commit -m "docs: your changes"

# Push and create PR
git push origin feature/your-feature

📄 License

MIT License - see LICENSE file for details.

About

No description, website, or topics provided.

Resources

Contributing

Stars

33 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Generated from mintlify/starter