Documentation Repository Internet of Agent

This repository contains the documentation for the project, built using Sphinx with the Read the Docs template. The documentation sources are written in Markdown.

Table of Contents

• Documentation Repository Internet of Agent
  • Table of Contents
  • Installation
    • macOS
    • Linux
    • Windows
  • Running local live server
  • Building the Documentation
  • Contributing
• Copyright Notice

Installation

To build the documentation locally, you need to install required dependencies.

Prerequisites

• Taskfile
• Uv
• Golang

macOS

• Install Taskfile and uv using Homebrew:

  brew install go-task/tap/go-task
  brew install uv

Linux

• Install Taskfile and uv using bash:

  sh -c '$(curl -fsSL https://taskfile.dev/install.sh)'
  curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

• Install Taskfile and uv using scoop:

  scoop install go-task
  scoop install main/uv

Running local live server

task run

Building the Documentation

To build the documentation, run the following command:

task build

This will generate the HTML documentation in the .build/site directory.

Contributing

Contributions are welcome! Please follow these steps to contribute:

Fork the repository. Create a new branch for your feature or bugfix. Make your changes. Submit a pull request.

Copyright Notice

Copyright Notice and License

Copyright AGNTCY Contributors (https://github.com/agentcy)