Skip to content

GaiaNet-AI/docs

Repository files navigation

Gaia Docs

Gaia is a decentralized AI infrastructure that empowers everyone to build, scale, and monetize personalized AI agents. This documentation project can be used by Gaia node operators, users, and creators.

Quickstart

  1. Fork the repository:

    • Visit the Gaia docs repository on GitHub
    • Click the "Fork" button in the top-right corner
    • Select where you want to fork the repository (your personal account or an organization)
  2. Clone your forked repository:`

    git clone https://github.com/YOUR-USERNAME/docs.git
    cd docs

Running the Documentation Locally

After forking and cloning the repository:

  1. Install dependencies:
    npm install
    
  2. Start the development server:
    npm start
    
  3. Open your browser and visit http://localhost:3000

Structure

  • docs/: Contains all the markdown files for the documentation
  • src/: Custom React components and pages
  • static/: Static assets like images
  • docusaurus.config.js: Main configuration file for Docusaurus

Deployment

This documentation is automatically deployed to docs.gaianet.ai when changes are merged into the main branch.

🤝 Contributing to Gaia docs

Gaia docs is an open-source project, and contributions from the community are highly valued! We believe in collaborative development to build a robust and innovative platform.

How You Can Contribute:

  • Reporting Issues: If you encounter bugs, have feature requests, or find areas for improvement, please open a detailed issue on GitHub Issues.

  • Submitting Pull Requests: We welcome code contributions! If you've implemented a bug fix or a new feature, submit a pull request following our Contribution Guidelines. Please ensure your code adheres to the project's style and includes relevant tests.

  • Documentation: Help us improve the documentation by clarifying existing sections, adding new guides, or translating the documentation into other languages.

  • Community Support: Assist other builders by answering questions on GitHub issues or our Telegram builders' Community.

Please take a look at our Code of Conduct to ensure a positive and inclusive environment for everyone.

Need Help?

Want to talk to the community? Hop in our Telegram and share your ideas and what you've build with Gaianet.

Find a bug? Head over to our issue tracker and we'll do our best to help. We love pull requests, too!

📜 License

This project is licensed under the Apache License 2.0

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 19

Languages