wenjin272 opened a new issue, #1228:
URL: https://github.com/apache/flink-agents/issues/1228

   Parent: #1225
   
   ### Problem and scope
   
   Setup and Quickstart mix installation, resource registration, and multiple 
Agent scenarios, while complete example entry points are hard to find.
   
   #### Scope
   
   - [ ] Make Setup cover prerequisites, script/manual installation, Java 
project dependencies, and the shortest path to submitting a first job. 
Introduce installation paths before referring to them in prerequisites.
   - [ ] Replace the generic API opening with guidance that helps choose an 
installation path; explain that YAML is loaded through Java/Python rather than 
a separate runtime installation.
   - [ ] Explain when distribution JARs must be supplied manually versus 
registered by the Python environment entry point. Base this on the hosting 
Flink job/submission entry point, not Agent definition language; state the 
applicable JAR and PYTHONPATH requirements.
   - [ ] Use `Developing with the Java API` for project setup; link advanced 
deployment to Operations.
   - [ ] Give each Quickstart links to complete Python/Java entry points, Agent 
definitions, and any required YAML before the walkthrough.
   - [ ] Separate environment creation from connection resource registration; 
explain how a chat-model setup references the connection name.
   - [ ] Split the Create an Agent Quickstart into a complete single-Agent 
walkthrough and an incremental multiple-Agent pipeline walkthrough, avoiding 
repeated Agent definitions.
   - [ ] Link Skills as a capability from the single-Agent path. Remove the 
Parallel LLM Calls Quickstart and its corresponding example, updating 
references; keep the agreed three top-level Quickstart paths.
   
   #### Coordination and acceptance
   
   Follow #1226's structure, #1227's language/submission distinctions, and 
Improve Agent core concepts, Actions, Events, and execution guides's Resource 
vocabulary. Prepare in parallel and rebase after structural changes. Verify 
complete example links and the supported Java/Python/YAML first-job journeys 
with current 0.4 APIs; report which examples were actually run.
   
   #### Review coverage
   
   DOC-007, DOC-008, DOC-012, DOC-013, DOC-014, DOC-015, DOC-016, DOC-017. 
These are traceability identifiers; the full actionable scope is described 
above.
   


-- 
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]

Reply via email to