Ready For V1#12
Merged
Merged
Conversation
…ility setup - Introduced new glossary entries for "What Is Multi-Agent Orchestration?" and "What Is RAG (Retrieval-Augmented Generation)?" with detailed explanations and Python examples. - Updated the API CLI configuration guide to include observability setup for Logfire and LangSmith. - Added a new guide on sending traces to Logfire and LangSmith using Python. - Enhanced checkpointing documentation to include SqliteCheckpointer for client-side agents. - Updated the use of publishers documentation to clarify OpenTelemetry span emissions. - Added SqliteCheckpointer reference in the Python checkpointers documentation. - Updated Docusaurus configuration to include glossary links in the navigation. - Added a new static file for AgentFlow overview and capabilities. - Updated robots.txt to allow AI search and citation bots.
…ability REST API endpoints - Introduced `graph.md` detailing methods for controlling and querying the graph in AgentFlowClient. - Added `llm.md` covering LLM utilities including `call_llm`, `create_llm_client`, and timeout management. - Created `evals.md` to document the REST API endpoints for listing and retrieving eval reports. - Added `observability.md` for the endpoint that reconstructs run traces with spans, events, and token usage.
- Created `evaluation-harness.md` to document the EvaluationRunner, ReporterManager, ExecutionResult, and pytest helpers for AgentFlow evaluation tests. - Introduced `check-external-links.mjs` script to verify external links in documentation, ensuring they are reachable and reporting any failures. - Added `verify_api_reference.py` script to validate that documented APIs match the actual implementations in the installed packages, checking imports, REST routes, and CLI commands.
- Deleted the outdated API reference documentation from production how-to. - Updated links in the production index to point to the new REST API reference. - Added a new conventions document for the REST API, detailing response envelopes, authentication, and permissions. - Adjusted sidebar configuration to remove the old API reference and include the new conventions document. - Improved the loading order and environment variable handling in the configuration documentation. - Enhanced the CSS for better readability of long identifiers in the table of contents.
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.
This pull request introduces several foundational improvements to the project, focusing on CI/CD automation, documentation clarity, and licensing. The most significant changes are the addition of a comprehensive CI workflow, a new MIT license, and substantial improvements and reorganizations in the documentation structure and authoring guidelines.
CI/CD and Licensing:
.github/workflows/ci.yml) to automate build, lint, typecheck, API verification, and external link checks for every pull request, push, and on a weekly schedule. This ensures code quality and documentation accuracy are continuously enforced.Documentation Structure and Authoring:
README.md, including updated directory overviews, new check commands, and explicit instructions for contributing and cutting documentation versions. [1] [2]docs/courses/COURSE_STYLE_GUIDE.mdtoCOURSE_STYLE_GUIDE.md, clarified its purpose as an authoring reference (not a published doc), and simplified its introduction.docs-mkdocs-legacy/Tutorial/beginner/01-your-first-agent.mdand the index fromdocs-mkdocs-legacy/Tutorial/beginner/index.md, likely in preparation for a new or reorganized tutorial approach. [1] [2]These changes establish a robust foundation for project quality, contributor guidance, and future documentation improvements.