Repository navigation
[docs] Document coding-agent Skill usage and refresh homepage navigation - #1273
Conversation
Add installation and usage guidance for flink-agents-dev, with Git references following the documentation branch. Explain scaffold boundaries and follow-up implementation, link the guide from Get Started, and organize homepage navigation and project metadata. Generated-by: Codex 26.1013.31256 (GPT-6) Co-authored-by: Codex <codex@openai.com>
sangkyoonnam
left a comment
There was a problem hiding this comment.
LGTM. I checked the guide against dev/agent-skills/flink-agents-dev/SKILL.md: the scaffolding boundary (focused TODOs and an explicit NotImplementedError or UnsupportedOperationException), resolving versions before generating anything, and never validating against the main schema when the target version has none all match what the page promises. The branch-dependent command holds up on a release branch too, since create_snapshot_branch.sh rewrites Branch to release-X.Y in config.toml; on main the page renders npx skills add 'apache/flink-agents#main@flink-agents-dev' and links to tree/main/dev/agent-skills/flink-agents-dev.
The ut-java [macos-latest] [java-11] [python-3.12] failure is setup-java failing to resolve api.adoptium.net before any build step runs, so it looks unrelated to this change; a rerun may clear it.
Linked issue: #1236
Closes #1236
Purpose of change
Add a Build with a Coding Agent guide and link it from Get Started so users can install and use
flink-agents-dev. The quotednpx skillscommand and source link use the documentation branch:mainfor development docs andrelease-0.4when that branch is configured. Skill updates can remain on the corresponding version branch without a separate release artifact.Explain what scaffolding generates, what remains unspecified, how to ask the coding agent to implement the remaining business behavior, and how to assess its validation results. Refresh homepage links to match the development and operations chapters, with project attribution and build time in a compact footer in the right column.
Tests
mainand simulatedrelease-0.4branch configurations (73 pages each).apache/flink-agents#main@flink-agents-devinto a temporary project for Codex using--agent codex --yes --copy. All installed files, including references and assets, matched the repository sources byte-for-byte.git diff --checkpassed.API
No public API changes.
Documentation
doc-neededdoc-not-neededdoc-includedWas this patch authored or co-authored using generative AI tooling?
Generated-by: Codex 26.1013.31256 (GPT-6)