This message was deleted.
# proj-documentation
d
This message was deleted.
f
• Quick overview of how it all works and best practices. • Repo • Public (Keyword) • Task • Open Source And everything relative to each one is in there.
The Public documentation is pretty confusing. "Unlike repository-specific microagents, public microagents are globally available across all repositories." This is true for open-source contributions but not for anything a user or team would add in their repo.
Public is really Open Source and pulled from the project.
b
That's how I had it before (minus the Task which doesn't seem implemented). But it was changed it seems. In your list what is "Open Source" referring to? The ones that are public?
f
Ya, Public seems more the Opensource agents. My concern is that the context of "public" for a company would be confusing. As that term is used for resources being shared externally. If we just clearly state opensource and it comes from the project that makes it easier.
b
Yeah makes sense. I'd like to sit down with Robert at some point to understand all of this. It's a really important piece that needs good documentation that people can follow. I do like: • Overview • Repo • Knowledge? • Task - When implemented • Open Source/Public?
👍 1
h
Hey folks! 👋🏽 I'm the one who added the recent content to this part of the docs in this PR. I wanted to explain this section of OpenHands better because I personally had a hard time figuring it out initially. I had to dig into the code to understand how these elements are loaded, when, and the proper
.md
file structure. I imagine users less comfortable with code would find this challenging. 😊 I agree "_public_" microagents is confusing. How about using "*global*," as seen in the code (memory/memory.py#L248)? Some other ideas: • embedded • core • native • integrated Also, using "_repository_" for both
repo.md
and the microagents within a repository felt ambiguous to me. Could we rename
repo.md
to something clearer? Maybe
workspace.md
as it is called in the code?
👋 1
👍 1
On the Tasks microagents, it seems the missing piece is the ability to trigger them from the UI. I didn't know that. Apologies for the confusion 😅 For this, we could implement a mention feature that would serve to manually append any microagent as well as other files in the workspace to the conversation context.
f
Hey Caique!
@better-park-34863: For the state of things and where things are going. The restructure of the pages like your outlined with some basic info will be a big win.
@happy-state-42428, for how the agent files are used, would a simple diagram help with a few use cases?
h
I added a diagram in the original PR explaining the activation but felt too much based on the feedback. We could come up with a more simplified visual explanation.
b
Thanks for the discussion folks. This is really helpful. There's a few things that we need to make clear that are really important for users. • Repository-specific ones: This part is confusing to me because it seems like inside here you have
repo
,
knowledge
and
tasks
. If all of these are microagents that users can add to their repos, we need to simply explain what is the use of each one and how they can create each one. • The Public one is not as important for users because they won't be touching that much. However, agreed that a better name might be good. • There's
knowledge
and
tasks
in both public and repository specific which makes things even more confusing. If I'm understanding this (I don't think I am), we should have this: • Overview (High level explanation of Repository specific + Public) • Repository-specific (This is the most important because this is where the users will need good documentation) ◦
repo.md
??? ◦ Knowledge ◦ Tasks @wooden-umbrella-84098 and @chilly-france-44439 I'd love to understand this so we can create a template for future microagents to be added easily
acknowledged 1
h
The “what are them” is explained in the. Repository-specific Microagents page. The “how” I attempted to answer with the Microagents Syntax .
Agree the “Public” is only relevant for contributors, maybe it should be moved to “For OpenHands Developers” section.