-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Closed
Description
The "Life of a Task" page in docs/topics/life-of-a-task.md is difficult to follow and comes across as unpolished. People tend to judge the quality of software by the quality of its documentation, so I think it would be a good idea to maintain high-standards.
For example, in the second paragraph:
A contextId logically composes many Tasks and independent Messages. Agent implementor can manage the llm context based on these interactions, utilizing the
contextId.
- The first "contextId" should probably be wrapped in backticks:
contextId - "A contextId logically composes many Tasks and independent Messages." is difficult to understand. "A
contextIdlogically groups multiple relatedTaskobjects and independentMessageobjects." is clearer and the language is more consistent with the other pages of the documentation. - "Agent implementor can manage the llm context based on these interactions, utilizing the
contextId." is not grammatically correct (i.e. "Agent implementor can manage..."). It's also difficult to understand, what is "Agent implementor", the person implementing the agent? "llm" should be uppercase "LLM".
Throughout the page there are more grammatical errors and inconsistent usage of backticks and capitalisation.
Metadata
Metadata
Assignees
Labels
No labels