First version of docs as I envisioned them #26
Merged
+326
−111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@copilot please review |
umeshma
approved these changes
Oct 15, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for Typeagent, replacing the previous query-focused docs with a complete user guide covering installation, basic usage, and API references. Additionally, it improves error visibility in the email testing tool by highlighting "No answer found" responses in red, and adds a clarifying comment to an unreachable code path.
Key changes:
- Restructured documentation with getting started guide, API reference, and environment variable setup
- Enhanced test_email.py to display query failures in red instead of green
- Added clarifying comment to unreachable case statement in conversation_base.py
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/README.md | Updated index with new documentation structure |
| docs/getting-started.md | New comprehensive getting started guide with example programs |
| docs/high-level-api.md | New API reference documenting classes and functions |
| docs/env-vars.md | New guide for configuring OpenAI and Azure OpenAI environment variables |
| docs/demos.md | New placeholder for demo reproduction instructions |
| docs/gmail.md | New placeholder for Gmail extraction documentation |
| docs/developing.md | New contributor guide with development setup info |
| docs/query-method.md | Removed previous query-focused documentation |
| tools/test_email.py | Enhanced to print failures in red color |
| typeagent/knowpro/conversation_base.py | Added clarifying comment to unreachable code path |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
umeshma
approved these changes
Oct 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also make test_email.py print failures in red.