Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links #2293

Merged
merged 8 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
python-version: [3.8]
python-version: ['3.10']

timeout-minutes: 30

Expand All @@ -32,9 +32,28 @@ jobs:
sudo apt-get update --fix-missing
sudo apt-get autoremove
sudo apt-get autoclean
pip install tomte[tox]==0.2.17
pip install tomte[tox]==0.2.2
pip install poetry
poetry update
poetry install --no-root
sudo npm install -g markdown-spellcheck
- name: Generate Documentation
run: tox -e docs
- name: Check spelling
run: tox -e spell-check

- name: Check doc links
run: tox -e check-doc-links

- name: markdownlint-cli2-action
uses: DavidAnson/[email protected]
with:
globs: /docs/*.md # optional, default is *.{md,markdown}

- name: Generate Documentation
run: |
find . -name "mkdocs.yml" | xargs -L1 sed -i.snrbck "s/materialx.emoji.twemoji/material.extensions.emoji.twemoji/g"
find . -name "mkdocs.yml" | xargs -L1 sed -i.snrbck "s/materialx.emoji.to_svg/material.extensions.emoji.to_svg/g"
find . -name "*.snrbck" | xargs -L1 rm

poetry run pip3 install mkdocs-material==9.4.10 mkdocs-material-extensions==1.3
poetry run pip3 install setuptools
poetry run mkdocs build --clean
nrosa-valory marked this conversation as resolved.
Show resolved Hide resolved
18 changes: 9 additions & 9 deletions docs/advanced_reference/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,49 @@ This page provides a quick reference to commonly used CLI commands in the Open A
### autonomy analyse
Analyse an agent service, including ABCI app specifications, docstrings, logs, and more.

[Detailed analyse documentation](./advanced_reference/commands/autonomy_analyse.md)
[Detailed analyse documentation](./autonomy_analyse.md)

### autonomy deploy
Deploy an agent service using various deployment backends (Docker, Kubernetes, or localhost).

[Detailed deploy documentation](./advanced_reference/commands/autonomy_deploy.md)
[Detailed deploy documentation](./autonomy_deploy.md)

### autonomy develop
Development tools for agent services.

[Detailed develop documentation](./advanced_reference/commands/autonomy_develop.md)
[Detailed develop documentation](./autonomy_develop.md)

### autonomy fetch
Fetch an agent or service from a registry.

[Detailed fetch documentation](./advanced_reference/commands/autonomy_fetch.md)
[Detailed fetch documentation](./autonomy_fetch.md)

### autonomy mint
Mint components and services on-chain.

[Detailed mint documentation](./advanced_reference/commands/autonomy_mint.md)
[Detailed mint documentation](./autonomy_mint.md)

### autonomy push-all
Push all available packages to a registry.

[Detailed push-all documentation](./advanced_reference/commands/autonomy_push_all.md)
[Detailed push-all documentation](./autonomy_push_all.md)

### autonomy replay
Replay tools for agent services.

[Detailed replay documentation](./advanced_reference/commands/autonomy_replay.md)
[Detailed replay documentation](./autonomy_replay.md)

### autonomy service
Manage on-chain services.

[Detailed service documentation](./advanced_reference/commands/autonomy_service.md)
[Detailed service documentation](./autonomy_service.md)

## Additional Information

- Most commands support the `--help` flag for detailed usage information
- Commands that interact with blockchains typically require a key file
- Many commands have additional options for customization and configuration
- See the [detailed command reference](./advanced_reference/commands/autonomy_analyse.md) for complete documentation of each command
- See the [detailed command reference](./autonomy_analyse.md) for complete documentation of each command

## Common Options

Expand Down
2 changes: 1 addition & 1 deletion docs/configure_service/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Here you will find:
- [The service configuration file](./service_configuration_file.md): Learn how to set up and customize your service's configuration
- [Configure access to external chains](./configure_access_external_chains.md): Guide for configuring your service to work with different blockchain networks
- [On-chain deployment checklist](./on-chain_deployment_checklist.md): Requirements and steps for deploying your service on-chain
- [Analyze and test](./analyze_test.md): Tools and practices for testing and analyzing your service
- [Analyze and test](./analise_test.md): Tools and practices for testing and analyzing your service
nrosa-valory marked this conversation as resolved.
Show resolved Hide resolved

These guides will help you properly configure and validate your agent service for both development and production environments.
16 changes: 8 additions & 8 deletions docs/guides/deploy_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ We illustrate the full local deployment workflow using the `hello_world` service
autonomy build-image #(1)!
```

1. Check out the [`autonomy build-image`](../../../advanced_reference/commands/autonomy_build-image) command documentation to learn more about its parameters and options.
1. Check out the [`autonomy build-image`](../advanced_reference/commands/autonomy_build-image.md) command documentation to learn more about its parameters and options.

After the command finishes, you can check that the image has been created by executing:

Expand Down Expand Up @@ -158,7 +158,7 @@ We illustrate the full local deployment workflow using the `hello_world` service
```

1. Delete previous deployments, if necessary.
2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options.
2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options.

This will create a deployment environment within the `./abci_build_*` folder with the following structure:

Expand Down Expand Up @@ -190,7 +190,7 @@ We illustrate the full local deployment workflow using the `hello_world` service
```

1. Delete previous deployments, if necessary.
2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options.
2. `-ltm` stands for "use local Tendermint node". Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options.

This will create a deployment environment within the `./abci_build_*` folder with the following structure:

Expand Down Expand Up @@ -218,7 +218,7 @@ We illustrate the full local deployment workflow using the `hello_world` service
autonomy deploy run #(1)!
```

1. Check out the [`autonomy deploy run`](../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-run) command documentation to learn more about its parameters and options.
1. Check out the [`autonomy deploy run`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-run) command documentation to learn more about its parameters and options.

This will spawn in the local machine:

Expand Down Expand Up @@ -359,7 +359,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS
autonomy fetch <TOKEN_ID> --use-mode # (1)!
```

1. `--use-mode` indicates that the service is registered in the Mode network. Check out the [`autonomy fetch`](../../../advanced_reference/commands/autonomy_fetch) command documentation to learn more about its parameters and options.
1. `--use-mode` indicates that the service is registered in the Mode network. Check out the [`autonomy fetch`](../advanced_reference/commands/autonomy_fetch.md) command documentation to learn more about its parameters and options.

Fetch the service with the desired token ID on Mode network.

Expand All @@ -370,7 +370,7 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS
autonomy build-image --service-dir your_service/ # (2)!
```

2. Check out the [`autonomy build-image`](../../../advanced_reference/commands/autonomy_build-image) command documentation to learn more about its parameters and options.
2. Check out the [`autonomy build-image`](../advanced_reference/commands/autonomy_build-image.md) command documentation to learn more about its parameters and options.

This command builds the Docker runtime images for the agent defined in a service configuration file service.yaml.

Expand All @@ -395,15 +395,15 @@ This means, in particular, that there is no need to define the `ALL_PARTICIPANTS
autonomy deploy build path/to/keys.json --kubernetes # (3)!
```

3. Check out the [`autonomy deploy build`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-build) command documentation to learn more about its parameters and options.
3. Check out the [`autonomy deploy build`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-build) command documentation to learn more about its parameters and options.

6. **Start the service.** Run the service:

```bash
autonomy deploy run # (4)!
```

4. Check out the [`autonomy deploy run`](../../../advanced_reference/commands/autonomy_deploy/#autonomy-deploy-run) command documentation to learn more about its parameters and options.
4. Check out the [`autonomy deploy run`](../advanced_reference/commands/autonomy_deploy.md#autonomy-deploy-run) command documentation to learn more about its parameters and options.

Run a service deployment locally stored.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/overview_of_the_development_process.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The figure below presents the development process with {{open_autonomy}}: from the idea of an off-chain service to its deployment in production. If you have completed the [quick start guide](../quick_start) you have already navigated through a significant part of this process.
The figure below presents the development process with {{open_autonomy}}: from the idea of an off-chain service to its deployment in production. If you have completed the [quick start guide](./quick_start.md) you have already navigated through a significant part of this process.

<figure markdown>
![](../images/development_process.svg)
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/publish_fetch_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ You can either:
Regardless of the methodology that you choose to develop your packages, it is important that they are developed with a clear separation of concerns, so that they can be reused in other projects.

## How to tell the framework what registry to use
The `push`, `add`, `publish` and `fetch` commands use, by default, the registry specified when the framework was initiated (command `autonomy init`). See for example the [set up guide](./set_up#set-up), where we initialized the framework to use the default remote [IPFS](https://ipfs.io) registry.
The `push`, `add`, `publish` and `fetch` commands use, by default, the registry specified when the framework was initiated (command `autonomy init`). See for example the [set up guide](./set_up.md), where we initialized the framework to use the default remote [IPFS](https://ipfs.io) registry.

Additionally, the framework configuration can be overridden per command by using the flags `--local` or `--remote` in any of the commands `push`, `add`, `publish` or `fetch`.

Expand Down
16 changes: 15 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
[tool.poetry]
name = "open-autonomy"
version = "0.1.0"
description = "Open Autonomy Framework"
authors = ["developer-valory <[email protected]>"]
license = "Apache-2.0 license"

[tool.poetry.dependencies]
python = "^3.10"
tomte = {extras = ["tox","docs"], version = "==0.2.15"}
mkdocs-monorepo-plugin = "^1.0.5"

[tool.poetry.dev-dependencies]
nrosa-valory marked this conversation as resolved.
Show resolved Hide resolved

[build-system]
requires = ["setuptools", "wheel"]
requires = ["setuptools", "wheel","poetry-core>=1.0.0"]
build_backend = "setuptools.build_meta"
Loading