About This Documentation

Overview

This documentation serves as the official resource for information about the AI Power Grid project. It provides comprehensive details about the platform, tokenomics, technical implementations, and ecosystem components.

Documentation System

MDX Format

These docs are written in MDX format, which combines the simplicity of Markdown with the power of JSX. This allows for:

  • Rich Content: Standard Markdown syntax for headings, lists, links, and code blocks
  • Dynamic Components: Integration of React components within the documentation
  • Interactive Elements: Embedding of interactive elements like code playgrounds and diagrams

MDX enables us to create documentation that is both easy to write and highly functional, making complex technical concepts more accessible through visual and interactive elements.

Local Development

You can run these docs locally on your machine to preview changes before submitting them:

  1. Clone the repository: git clone https://github.com/aipowergrid/aipg-documentation.git
  2. Install dependencies: pnpm install
  3. Start the development server: pnpm run dev
  4. Access the docs at http://localhost:3000

Local development allows you to see how your changes will look in production before submitting them.

Continuous Deployment

Our documentation follows a continuous deployment model:

  • Automatic Updates: Pull requests merged into the main branch are automatically deployed to production
  • Preview Deployments: PRs generate preview links so changes can be reviewed before merging
  • Version Control: All documentation changes are tracked through Git, allowing for easy rollbacks and history tracking

This approach ensures that the most up-to-date information is always available to users while maintaining a structured review process.

Contributing

We welcome contributions from the community to improve these docs. Here's how you can contribute:

Making Changes

  1. Fork the Repository: Create your own copy of the documentation repository
  2. Create a Branch: Make a new branch for your changes
  3. Make Edits: Update or add content in the MDX files
  4. Submit a PR: Create a pull request with a clear description of your changes

Contribution Guidelines

When contributing to the documentation, please follow these guidelines:

  • Be Clear and Concise: Write in a clear, straightforward manner
  • Follow Formatting: Maintain consistent formatting with the rest of the documentation
  • Add Value: Ensure your changes add valuable information or improve clarity
  • Include References: Provide sources for technical claims where appropriate
  • Test Locally: Check that your changes render correctly locally before submitting

Review Process

All contributions go through a review process:

  1. Initial Review: Maintainers will review your PR for accuracy and quality
  2. Feedback: You may receive feedback or requests for changes
  3. Approval and Merge: Once approved, your changes will be merged into the main branch
  4. Deployment: Merged changes are automatically deployed to the production site

Documentation Structure

The documentation is organized into the following main sections:

  • Introduction: Overview of the AI Power Grid platform
  • Tokenomics: Details about AIPG token economics and emission schedule
  • ARC20 Token Network: Information about our token standard for AI applications
  • Technical Documentation: Deep dives into the technical implementations
  • Guides and Tutorials: Step-by-step instructions for users and developers

Each section is designed to be accessible to users with varying levels of technical expertise, from newcomers to experienced developers.

We're committed to continuously improving these docs to better serve the AI Power Grid community.