wenjin272 opened a new issue, #1226:
URL: https://github.com/apache/flink-agents/issues/1226
Parent: #1225
### Problem and scope
The documentation mixes core Agent authoring, resource capabilities,
built-in agents, and integration topics at the same level. Entry points and
naming differ between the homepage, Overview, and sidebar.
Implement the following navigation structure using existing content, page
moves/splits, and minimal introductory text. Keep this change focused so it can
merge early; detailed Resource explanations belong to Improve Agent core
concepts, Actions, Events, and execution guides and tutorial rewrites to
Improve Setup and the Quickstart user journey.
```text
Get Started
├── Overview
├── Setup
└── Quickstart
├── Create an Agent
│ ├── Build a Single Agent
│ └── Connect Multiple Agents in One Flink Job
├── Built-in ReAct Agent
└── YAML Agent
How to Build an Agent
├── Create an Agent
│ ├── Overview
│ ├── Choose APIs and Languages
│ ├── Actions
│ ├── Events
│ ├── Resources (if there is sufficient independent, shared content)
│ └── YAML API
├── Calling LLMs
│ ├── Declare the Resources
│ │ ├── Built-in Chat Model Providers
│ │ └── Model Routing
│ ├── Chat with Models
│ ├── Tool Use
│ ├── MCP
│ └── Skills
├── Memory
│ ├── Overview
│ ├── Sensory & Short-Term Memory
│ ├── Long-Term Memory
│ └── Memory Events
├── Vector Search
│ ├── Embedding Models
│ ├── Built-in Embedding Model Providers
│ ├── Vector Stores
│ └── Built-in Vector Store Providers
├── Multi-Agent
│ ├── Sub-Agents
│ └── Add Multiple Agents in One Flink Job
├── Built-in ReAct Agent
└── Integrate with Flink
```
#### Scope
- [ ] Use `Agent` for the base event/action programming model and `Built-in
ReAct Agent` for the subclass; remove the implication that there is a separate
WorkflowAgent class.
- [ ] Implement the navigation groups and page responsibilities above. Keep
the four Vector Search pages at the same level.
- [ ] Synchronize homepage, Overview, and sidebar Quickstart entry points.
Skills is a capability guide; Coding-agent Skill is an optional authoring aid,
coordinated with Improve Setup and the Quickstart user journey and Add
documentation and release entry points for the Coding-agent Skill.
- [ ] Preserve necessary old URL aliases, update internal links, and avoid
empty navigation destinations.
#### Acceptance
The documentation builds, navigation resolves, old URLs remain usable where
appropriate, and the homepage/sidebar agree. Content moves preserve existing
guidance; substantive topic rewrites are owned by the corresponding child
issues.
#### Review coverage
DOC-001, DOC-003, DOC-004, DOC-005. 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]
