microsoft / microsoft/simplechat

Improve agent documentation and walkthrough guidance

Open
#993 0 comments 0 reactions 1 assignee View on GitHub

@paullizer is already working on this.

Since Jul 2, 2026.

documentation
Dominant language
Python
Stars
152
Forks
116
Avg merge
7h 7m
Merged PRs (30d)
122

Description

## Summary
Improve SimpleChat's agent documentation so users and admins can understand what agents are, how agents are used, and how to choose, configure, and work with them effectively.

## Scope
- Explain what agents are in SimpleChat, including their role in chat workflows, tools/actions, prompts/instructions, and workspace contexts.
- Document common agent usage patterns for end users and admins, including selecting agents, configuring agents, and understanding when to use an agent versus standard chat.
- Add or improve agent-related docs pages, descriptions, walkthroughs, and references from existing documentation entry points.
- Identify and link relevant video content or create descriptions/outlines for agent walkthrough videos where video assets are planned or available.
- Clarify related terminology such as agents, actions/tools, workflows, knowledge sources, and workspace scope.

## Acceptance Criteria
- [ ] Agent documentation includes a clear "What are agents?" explanation for non-expert users.
- [ ] Documentation explains how agents are used from both user and admin perspectives.
- [ ] Agent setup, selection, and configuration guidance is linked from the main docs navigation or relevant landing pages.
- [ ] Agent docs include practical examples or walkthrough scenarios.
- [ ] Video descriptions, outlines, or links are added where agent video content exists or is planned.
- [ ] Related existing docs are reviewed for consistency and updated to point to the improved agent documentation.

## Notes
This is a documentation-focused improvement; no product behavior changes are expected unless gaps are discovered while documenting.

Related but not duplicate:
- #943 tracks a broader SimpleChat walkthrough video set.
- #959 tracks admin walkthroughs for common agent templates.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.