Enhance AI documentation with best practices and tool calling guidance - #490
Draft
Devon-White wants to merge 28 commits into
Draft
Enhance AI documentation with best practices and tool calling guidance#490Devon-White wants to merge 28 commits into
Devon-White wants to merge 28 commits into
Conversation
- Added "max-toc-depth" to best practices and index pages for improved navigation. - Expanded best practices section with insights on over-prompting and examples. - Introduced a new "Next steps" section in best practices and index pages linking to relevant resources. - Updated references to tool calling in various documents to ensure consistency and clarity. - Created a comprehensive guide on tool calling, detailing its importance and implementation in AI agents. - Improved descriptions and links in existing AI documentation for better user understanding.
Contributor
…SDK across multiple guides
…on methods and no-code options
- Replace ai-agent.svg with light/dark ai-agent-flow SVG pair using the CSS-only .light-only/.dark-only pattern in styles.css - Convert capabilities build-methods prose to a CardGroup - Use docstring-driven tool definition in the drive-thru example so the inferred schema keeps the parameter description; add required to the SWML variant for parity - Trim aphorisms: reword menu-liability line, drop the duplicated suggestion/constraint line from best practices - Fix stale /docs/swml/reference/ai link in the overview use cases
- Updated the "No-code agent" guide to enhance clarity and improve structure. - Removed unnecessary elements and streamlined instructions for creating AI agents. - Revised "Best practices for creating a SignalWire AI agent" to remove author metadata and improve focus on content. - Enhanced "Prompt engineering best practices" with clearer language and better organization. - Improved "Prompt engineering" overview to emphasize clarity and structure in prompt writing. - Clarified the "Where to apply prompt engineering" guide, ensuring better understanding of prompt areas. - Revised "AI overview" to emphasize the capabilities of SignalWire AI and streamline the quickstart instructions. - Updated "Getting started" documentation for better flow and clarity, including clearer distinctions between SDKs and approaches.
…ngineering and capabilities
Contributor
|
Requested by: Devon White |
Single theme-aware AI flow diagram SVG
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Restructures the AI platform section around tool calling and production best practices. Closes #489.
What changed
/ai/tool-calling) — the mental model (the AI agent is the front end, your code owns the business logic), how a SWAIG function works, a complete order-status agent in SWML and the Python Server SDK, and five patterns for reliable SWAIG functions./ai/best-practices) — restructured around the prompt/code split, writing for real-time voice (end-pointing and turnaround), speech-recognition hints, testing and monitoring with post-prompt reports, and TCPA compliance, ending with a complete worked example that shows the request/response exchange..light-only/.dark-onlyrules instyles.css)./docs/swml/reference/aipaths, standardized "Next steps" sections.ai-agent.svg.