This repository contains the documentation for the project, built using Material for MkDocs. The documentation sources are written in Markdown.

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

To build the documentation locally, you need to install the following dependencies:

• Taskfile
• Uv
• Golang

• Install Taskfile and uv using Homebrew:

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

• Install Taskfile and uv using bash:

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

• Install Taskfile and uv using scoop:

  scoop install go-task
  scoop install main/uv

task run

To build the documentation, run the following command:

task build

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

See the How to Contribute page for more information.

Before creating a release, ensure that:

• All necessary features and fixes are merged into the main branch.

1. Create and annotate the release tag:

   git tag -a v0.2.1 -m "v0.2.1"

2. Push the tag to trigger the GitHub Action:

   git push origin v0.2.1

3. Wait for the GitHub Action to complete building the documentation artifacts.
4. Navigate to the releases page on GitHub.
5. Find the draft release created by the GitHub Action.
6. Select the previous version tag to compare against.
7. Click "Generate release notes" in the draft release.
8. Review the generated release notes.
9. Publish the release.

Copyright Notice and License

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