Skip to content

Fix agent-doc inconsistencies and CI-verify the factory index#108

Merged
jcgueriaud1 merged 1 commit into
masterfrom
agent-docs-consistency
Jul 6, 2026
Merged

Fix agent-doc inconsistencies and CI-verify the factory index#108
jcgueriaud1 merged 1 commit into
masterfrom
agent-docs-consistency

Conversation

@jcgueriaud1

Copy link
Copy Markdown
Collaborator

The hand-written agent docs contradicted the actual API, causing agents to emit non-compiling code or run non-existent commands. Fix the source of the drift and the individual mistakes:

  • generate-api-reference.java: emit an Element index (tag -> wrapper ->
    factory methods) derived from the @PlaywrightElement annotation and each
    wrapper's real static factories. Factory methods are NOT uniform, and this
    table is now the authoritative, CI-verified list (api-reference.yml already
    fails stale PRs), preventing element-mapping.md drift.
  • element-mapping.md: drop the false "every element has get/getByLabel/getById" claim; mark the Key Methods column illustrative and point to the index.
  • AGENTS.md: fix wrong package (org.vaadin.dramafinder ->
    org.vaadin.addons.dramafinder) and replace bogus multi-module/spring-boot:run commands with the real single-module -Pit verify flow.
  • README.md: fix stale sortable-layout-demo module reference.
  • SKILL.md: correct issue URL vaadin -> parttio.
  • setup.md: bump KNOWN_LATEST fallback 1.1.1 -> 1.1.2.

The hand-written agent docs contradicted the actual API, causing agents to
emit non-compiling code or run non-existent commands. Fix the source of the
drift and the individual mistakes:

- generate-api-reference.java: emit an Element index (tag -> wrapper ->
  factory methods) derived from the @PlaywrightElement annotation and each
  wrapper's real static factories. Factory methods are NOT uniform, and this
  table is now the authoritative, CI-verified list (api-reference.yml already
  fails stale PRs), preventing element-mapping.md drift.
- element-mapping.md: drop the false "every element has get/getByLabel/getById"
  claim; mark the Key Methods column illustrative and point to the index.
- AGENTS.md: fix wrong package (org.vaadin.dramafinder ->
  org.vaadin.addons.dramafinder) and replace bogus multi-module/spring-boot:run
  commands with the real single-module -Pit verify flow.
- README.md: fix stale sortable-layout-demo module reference.
- SKILL.md: correct issue URL vaadin -> parttio.
- setup.md: bump KNOWN_LATEST fallback 1.1.1 -> 1.1.2.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jcgueriaud1
jcgueriaud1 merged commit 2c02326 into master Jul 6, 2026
4 checks passed
@jcgueriaud1
jcgueriaud1 deleted the agent-docs-consistency branch July 6, 2026 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant