Skip to content

[docs] Document coding-agent Skill usage and refresh homepage navigation - #1273

Merged
wenjin272 merged 1 commit into
apache:mainfrom
wenjin272:codex/docs-coding-agent-skill
Oct 17, 2026
Merged

wenjin272 merged 1 commit into
apache:mainfrom
wenjin272:codex/docs-coding-agent-skill

Conversation

@wenjin272

Copy link
Copy Markdown
Contributor

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 quoted npx skills command and source link use the documentation branch: main for development docs and release-0.4 when 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

  • Hugo extended 0.110.0 builds from a clean source export passed with both main and simulated release-0.4 branch configurations (73 pages each).
  • Verified 175 internal page/fragment links across the homepage, Get Started overview, and new guide for each build; checked the rendered installation command and source link for both branches.
  • Skills CLI 1.7.2 installed apache/flink-agents#main@flink-agents-dev into a temporary project for Codex using --agent codex --yes --copy. All installed files, including references and assets, matched the repository sources byte-for-byte.
  • Apache RAT 0.16.1 recognized Apache license headers in all six changed files.
  • Inspected the homepage in the local browser preview. git diff --check passed.
  • No coding-agent application-generation or live model/service end-to-end run was performed. The release-branch configuration check verifies rendering, not installation from a future branch.

API

No public API changes.

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

Was this patch authored or co-authored using generative AI tooling?

  • Yes
  • No

Generated-by: Codex 26.1013.31256 (GPT-6)

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>
@github-actions github-actions Bot added doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue. labels Oct 16, 2026

@sangkyoonnam sangkyoonnam left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@wenjin272
wenjin272 merged commit 7548534 into apache:main Oct 17, 2026
28 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-included Your PR already contains the necessary documentation updates. fixVersion/0.4.0 priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Doc] Add installation and usage documentation for the Coding-agent Skill

2 participants