Doc changes after review

valory-xyz / open-autonomy

A framework for the creation of autonomous agent services.

Apache License 2.0

79 stars 25 forks source link

Proposed changes

Doc changes after review

Fixes

If it fixes a bug or resolves a feature request, be sure to link to that issue.

Types of changes

What types of changes does your code introduce? (A breaking change is a fix or feature that would cause existing functionality and APIs to not work as expected.) Put an x in the box that applies

[ ] Non-breaking fix (non-breaking change which fixes an issue)
[ ] Breaking fix (breaking change which fixes an issue)
[ ] Non-breaking feature (non-breaking change which adds functionality)
[ ] Breaking feature (breaking change which adds functionality)
[ ] Refactor (non-breaking change which changes implementation)
[ ] Messy (mixture of the above - requires explanation!)

Checklist

Put an x in the boxes that apply.

[ ] I have read the CONTRIBUTING doc
[ ] I am making a pull request against the main branch (left side). Also you should start your branch off our main.
[ ] Lint and unit tests pass locally with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have locally run services that could be impacted and they do not present failures derived from my changes
[ ] Public-facing documentation has been updated with the changes affected by this PR. Even if the provided contents are not in their final form, all significant information must be included.
[ ] Any backwards-incompatible/breaking change has been clearly documented in the upgrading document.

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.39%. Comparing base (e6f2b08) to head (b044e92).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #2220 +/- ## ========================================== - Coverage 94.39% 94.39% -0.01% ========================================== Files 260 260 Lines 16104 16104 ========================================== - Hits 15202 15201 -1 - Misses 902 903 +1 ``` | [Flag](https://app.codecov.io/gh/valory-xyz/open-autonomy/pull/2220/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=valory-xyz) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/valory-xyz/open-autonomy/pull/2220/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=valory-xyz) | `94.39% <ø> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=valory-xyz#carryforward-flags-in-the-pull-request-comment) to find out more.

valory-xyz / open-autonomy