Changes to Links into Clickable Cards

Most of the endpoints depends on various instances and are considered parameters for the actual endpoint, but these are not meant to be passed directly by the user.
Instead, these instance-dependent elements are integrated and managed directly by the backend system. We refer to them as name_parameter, where the asterisk () is used to denote a specific instance-dependent parameter that the route relies on.

https://fetch.ai/docs/apis/ai-engine/chat

DeltaV: web chat interface.
AI engine: LLM powered Backend

https://fetch.ai/docs/apis/ai-engine/chat

Prerequisites

• I checked the existing issues and made sure there are no similar bug reports

Category

Incorrect or missing Content

Expected Behavior / Content

The API documentation should refer to the backend as "AI Engine" instead of "DeltaV".

Observed Behavior / Content

The API documentation currently refers to the backend as "DeltaV" instead of "AI Engine".

To Reproduce

No response

Environment Details (Optional)

No response

Failure Logs (Optional)

No response

Additional Information (Optional)

No response

The code can be uploaded as a single string (like the current example) or a JSON string with multiple file objects as follows:

import requests

data = {
    "code": '{[{"id": 0, "language": "python", "name": "agent.py", "value": <contents>}, {"id": 1, "language", "plaintext", "name": ".env", "value": <contents>},...]}'
}

pathParameters = {
    "agentAddress": "agent1q2dfhywtt8xazrdyzgap6gzdd7uhk4e0wmc3gjqt42esauaegcm8cuvclpj"
}

requests.put("https://agentverse.ai/v1/hosting/agents/{pathParameters.agentAddress}/code", json=data, headers={
    "Authorization": "bearer <your token here>"
}
    

Sending user json message
Request for creating a new agent

Sending stop message
Request for creating a new agent

Sometimes bookmarks arent saved (page is bookmarked but bookmark list is empty)

Implementation: Each version of the documentation should correspond to a specific version of uAgents, with clear navigation to switch between versions.
Benefits: Ensures users can access the relevant documentation for the specific version of uAgents they are using, preventing confusion and errors.

Specifying Component Versions:

•   Define the versions for running components like uAgents.
  

•   Ensure compatibility and eliminate confusion by stating the exact versions required for installations and tutorials.
  

Update warnings: have a warning sign on pages that might be out of date/currently under construction etc.
Keep track of old versions? as user base grows they might need to know what is deprecated etc

https://github.com/marketplace/actions/broken-link-checker-action

Prerequisites

• I checked the existing issues and made sure there are no similar bug reports

Category

Incorrect or missing Content

Expected Behavior / Content

The course overview for "Agents 101 for AI Engine" should mention the correct version of the AI Engine package, which is 0.5.0.

https://pypi.org/project/uagents-ai-engine/

Observed Behavior / Content

The course overview currently mentions an outdated version of the AI Engine package, which is 0.4.0.

To Reproduce

No response

Environment Details (Optional)

No response

Failure Logs (Optional)

No response

Additional Information (Optional)

Suggestion: Dynamically display the latest version number of the AI Engine package.

Community Contributions

Implementation:

• Add a “Contribute” button, allowing users to suggest edits or improvements, ask questions, answer questions, and upvote/downvote (Stack Overflow style).
  Benefits:
• Engages the community in maintaining and improving the documentation, helping fellow developers and enhancing the developer experience.

User-specific Input - Agent Functions

In several guides, part of the example code must be replaced with user-specific input (for example, an agent address or an IP address).
In some cases, the code is split up into small code blocks that are all explained individually, however in other cases these appear in large code blocks that are expected to be copy/pasted by the user. The description accompanying these code blocks rarely mentions the replacements that need to be made.
I would suggest mentioning the replacement in the description. Additionally, for cases like an IP address, a description on how to find your IP address for users who do not know could be useful (eg ipconfig).

The tags and tag filtering aren't very intuitive:

• can only filter by a tag from a page that already has a tag in it
• when selecting a tag for filtering it isnt clear what tag is selected
• its not quite clear that the tags are even selectable + what happens when you click one

I found a bit of repeated code examples and sections in Options for running your Agents, Agent Mailboxes, Agent Functions, and Make your agents AI Engine compatible. I found this a bit confusing to follow. I think it would be better to merge these 4 sections into less sections, without the repetitions.

So in CI I have commented the step of running node index-data-to-alogolia.js for now, as running this every-time we make a build will create a lots of repeated data in Algolia, so for that I will figure out a way in which, we will check if the commit contains any mdx file changes, then only index the changes of that committed file only, as rest of the changes already exists

Summary

Use the built in istio metrics to be able to track the 404 errors occur on the website. This should be part of an automated process where the team can review 404 errors. In the case of dead links a temporary redirects should be setup. Otherwise this can be used a signal for missing pages / content

Links to suitable resources selected by the community for further reading on certain topics could also be added to the references page.
For example, 'Blockchain'.

The following needs to be changed/corrected to apply GTM.

GENERAL:

• Buttons in top nav bar: Concepts, Guides, Examples References and APIs buttons
• Social media icons at the bottom pf the website
• Fetch logo in Heading

HOME PAGE:

• Home page: courses cards

CONCEPTS LANDING PAGE:

• Boxes for Introduction resources un Concepts landing page for all topics (e.g., Agentverse, Ledger, Ai Engine…)
• Side menus elements

GUIDES LANDING PAGE:

• Side menus elements

EXAMPLES LANDING PAGE:

• Side menus elements

REFERENCES LANDING PAGE:

• Side menus elements

APIs LANDING PAGE:

• Side menus elements

• Implementation: Embed interactive code editors(REPL) or link to DeltaV within the documentation
• Benefits: Provides hands on learning experience, enabling users to understand + experiment with code snippets in real-time.

23 positive How to request the service from a blockchain transaction when the agent is on-chain? /guides/agents/cleaning-demo

How to fetch and save the tables of the restaurant from an endpoint (with an authenticated request)?

/guides/agents/booking-demo

Added Dark Mode😍 (Because light attracts bugs 😂, That’s why developers love dark mode)

Figma Preview.
Figma Design

**_- We can add a live preview feature to enhance user interaction.

• Integrate the docs into a platform like GitBook for better usability._**

Error Status of a Page and 'Last Updated' time stamp

- The overall skeleton

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Additional Information (Optional)

No response

In Register a local Agent Function on the Agentverse and Make your agents AI Engine compatible (as mentioned in point 1, there is some repetition) it says to paste your local's agent address in the Agentverse page.

However, I found that it takes at least 5 minutes after the launch of the local agent before the address is recognised, and until then, it gives an error like in the following screenshot: see (https://github.com/fetchai/docs-v2/issues/598)

Elsewhere in the guides, there is a brief mention of a 5 minutes wait (in Agent Handlers). However I feel like it might be useful to the users to add another mention in the sections mentioned above, as it wasn't obvious to me that I had to wait before the agent would be recognised.

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

The documentation homepage is missing an H1 tag. For optimal SEO performance, each page should contain exactly one H1 tag. The H1 tag serves as the primary heading and helps search engines understand the main topic of the page. Without an H1 tag, the page's SEO ranking can be negatively affected, reducing visibility in search engine results. Adding an H1 tag will improve the structure and accessibility of the content, ensuring better search engine indexing and user experience.

Additional Information (Optional)

No response

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Currently our docs is using Next.js version 13.4.10. Although there are no known security vulnerabilities in this version, it is outdated. The latest version, 14.2.5, includes new features, performance improvements, and bug fixes.

Additional Information (Optional)

No response

6. Communicating with other agents wallet

Getting error:

Debugging:

As it showing babble module not found, as the error inside the uagent package library but still I try to install the babble by using “pip install babble”

But still getting error: \

Solution:

Not found! Still searching…

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

the "User-flow" tag doesn’t make much sense to me

Additional Information (Optional)

No response

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

We can hide or remove the "Delete Function Group" API section since it's no longer relevant. Currently, we have only three function groups:

[
  {
    "uuid": "523a7194-214f-48fd-b5be-b0e953cc35a3",
    "name": "Fetch Verified",
    "isPrivate": false
  },
  {
    "uuid": "1819040f-dc8f-4f77-9e0c-acddd66a9bd0",
    "name": "My Functions",
    "isPrivate": true
  },
  {
    "uuid": "12c8601c-cccd-42de-a5f1-7eab76ae3121",
    "name": "Public",
    "isPrivate": false
  }
]

Users can't delete any of these function groups for now, so there's no need to include that API section.

Additional Information (Optional)

No response

Please explain wherever appropriate that when testing interactions with agents that use Dialogues / ChitChat, users must select Next generation personality type in the DeltaV options.

App store link is not correct on wallet guide.
https://fetch.ai/docs/guides/fetch-network/fetch-wallet/mobile-wallet/get-started

current: https://apps.apple.com/au/app/
correct: https://apps.apple.com/in/app/fetch-ai-wallet/id1641087356

Prerequisites

• I checked the existing issues and made sure there are no similar bug reports

Category

Incorrect or missing Content

Expected Behavior / Content

We should use "check out" when referring to the verb (e.g., "Please check out this feature"). We should use "checkout" when referring to the noun (e.g., "Proceed to checkout").

Observed Behavior / Content

Most instances in our documentation incorrectly use "checkout" instead of "check out" when referring to the verb.

To Reproduce

No response

Environment Details (Optional)

No response

Failure Logs (Optional)

No response

Additional Information (Optional)

No response

An 'extras category that summaries all the previously mentioned links to external resources. This category also includes 'FAQs'
Much of the content for 'FAQs' can be obtained by sending surveys to team members who attended the Summit. The 'comments' section detailed in the next suggestion could also be utilised.

On pages where we explicitl use uagents_ai_engine library let's reference that installation.

pages like: https://fetch.ai/docs/guides/agents/intermediate/ai-engine-compatible-agent should mention the install requirements.

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Our current canonical tag implementation in the HTML uses a relative URL, which can cause SEO issues. The canonical tag helps search engines identify the preferred version of a webpage, and using a full URL ensures clarity and effectiveness.

<link rel="canonical" href="/docs/">

Problem:

The href attribute is a relative URL (/docs/), which can be ambiguous for search engines.
This might lead to indexing issues or duplicate content penalties, as search engines may not correctly interpret the canonical page.

Solution:
Update the canonical tag to use the full URL to make it clear and unambiguous for search engines.

Suggested Implementation:

<link rel="canonical" href="https://fetch.ai/docs/">

• Using the full URL (https://fetch.ai/docs/) in the canonical tag ensures that search engines know exactly which URL is the canonical one.
• This prevents potential SEO issues such as duplicate content penalties and indexing problems, leading to better search engine performance for our site.

This change will improve our site's SEO by ensuring that search engines correctly identify the canonical page, leading to better indexing and ranking.

Additional Information (Optional)

No response

Motivation

• The documentation page has been recently updated, but it left the References Page to be less useful and not quite properly implemented
• Touch up the page to maintain useful information without cluttering users with too much information

Implementation

• Edit the sidebar to reflect the changes made from the update of the docs
• Make the Landing page on the References page more informative as to what is included in the page

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Currently, the package version is hard-coded in our documentation. This means every time a new version is released, we need to manually update the version number throughout the docs. This process is time-consuming and prone to errors.

We should either create a process that ensures the version is updated across all docs with every release, or better yet, implement a solution that dynamically fetches and displays the latest version of the package in the documentation. This will save time and ensure our documentation is always up-to-date.

Additional Information (Optional)

No response

Under References Tab in Left side navigation menu:

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Services -> Functions

Additional Information (Optional)

No response

• Implementation: Add a “Contribute” button, allowing users to suggest edits or improvements, ask questions, answer questions and Upvote (Stack Overflow style).
• Benefits: Engages the community in maintaining and improving the documentation, help fellow developers and help the team in improving the dev experience.

Some form of optional progression tracker.

Prerequisites

• I checked the existing issues and made sure there are no similar bug reports

Category

Incorrect or missing Content

Expected Behavior / Content

The documentation should reflect the current version of the uAgents package, which is 0.15.1 as per PyPI.

Observed Behavior / Content

The documentation currently mentions the package version as 0.12.0.

To Reproduce

No response

Environment Details (Optional)

No response

Failure Logs (Optional)

No response

Additional Information (Optional)

Suggestion: Dynamically display the latest version number of the uAgents package in the documentation to ensure it is always up to date.

Prerequisites

• I checked the existing issues to make sure this feature has not already been requested

Feature

Hi team,

I’ve reviewed our guide on creating Agents and Agent Functions in Agentverse using APIs:
Agent Function Creation APIs.

There’s a specific line that might affect our SEO and user experience:

"Go to Profile section in Agentverse ↗️."
If users are not logged in, they will be redirected to a 404 page. This could confuse users and hurt our SEO.

To improve this, I suggest adding clear instructions for logging in first. Here’s the revised version:

How to Get Agentverse API Tokens:

Log in to Your Agentverse Account:
Go to the Agentverse login page and log in with your credentials.
Access the Profile Section:
Once logged in, navigate to your Profile section in Agentverse.
Ensure you log in to avoid encountering a 404 error.

Please update the guide accordingly to enhance user experience and SEO.

Additional Information (Optional)

No response