yunfengzhou-hub opened a new pull request, #1271: URL: https://github.com/apache/flink-agents/pull/1271
Linked issue: closes #1228 ### Purpose of change Setup and the Quickstart mixed installation steps, Resource registration, and multiple Agent scenarios, and the complete example entry points were hard to find. This PR reworks both around the reader's first-job journey, on the navigation structure merged in #1244. - Setup introduces the two installation paths before referring to them, and states the distribution JAR and PYTHONPATH requirements by hosting Flink job (submission entry point) rather than by Agent language. `Developing with the Java API` covers project setup, and advanced deployment links to Operations. - Each Quickstart lists its complete Python/Java entry points, Agent definitions, and required YAML before the walkthrough. - Environment creation is separated from connection Resource registration, and each page explains how a chat model setup references the connection by name. - The Create an Agent Quickstart is split into a complete single-Agent walkthrough and an incremental multiple-Agent pipeline walkthrough that does not repeat the Agent definitions. - The preparation steps that each of the four Quickstart pages duplicated are collected once under Quickstart → Before You Begin. - The Parallel LLM Calls Quickstart and its examples are removed per DOC-008 (special manual orchestration, not a recommended pattern), together with the example-only types they used. The pattern is intentionally not migrated to another page. - Skills is linked as a capability from the single-Agent path, and the three top-level Quickstart paths remain. ### Tests Documentation-only change; no runtime code is touched. - Hugo 0.110.0 build passed with no warnings (71 pages). - Validated every in-page and cross-page anchor across the rendered site: 171 anchored links, 0 broken. All 28 `gh_link` targets exist in the repository. - Checked each documentation code block line by line against the example source it is taken from. All Python and Java lines match verbatim except four intentional `...` placeholders, and both YAML blocks are byte-identical to `yaml_review_analysis_agent.yaml`. - Parsed every Python block with `ast.parse`, which caught and fixed one unmatched parenthesis. - Verified the referenced APIs and options against source: `ReActAgent(ResourceDescriptor, Prompt, Object)` at `api/src/main/java/org/apache/flink/agents/api/agents/ReActAgent.java:95`, the `install.sh` flags and interactive prompts, and `FLINK_AGENTS_SKIP_JAR_DOWNLOAD` / `FLINK_AGENTS_MAVEN_MIRROR` at `python/_build_backend/backend.py:73-75,109`. - `git diff --check` passed. - Not run: the Quickstart jobs end to end against a local cluster with Ollama, and a standalone `javac` compile of the documentation snippets. The snippets are verbatim copies of examples that CI compiles. ### API No public API changes. Removes the example-only `ParallelChatRequestExample` and `ParallelChatAgent` with their Python counterparts, plus the `SentimentRequest`, `SentimentKeySelector`, `AspectResponse`, and `SummaryResponse` types that only those examples used. ### Documentation - [ ] `doc-needed` - [ ] `doc-not-needed` - [x] `doc-included` ### Was this patch authored or co-authored using generative AI tooling? - [x] Yes - [ ] No Generated-by: Qoder 0.4.4 (Qwen 3.8 Max) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
