这是indexloc提供的服务,不要输入任何密码
Skip to content

"Life of a Task" page in docs/topics/life-of-a-task.md is difficult to follow #836

@benclarkegithub

Description

@benclarkegithub

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.

  1. The first "contextId" should probably be wrapped in backticks: contextId
  2. "A contextId logically composes many Tasks and independent Messages." is difficult to understand. "A contextId logically groups multiple related Task objects and independent Message objects." is clearer and the language is more consistent with the other pages of the documentation.
  3. "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
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions