Skip to content

chore: document adoc anchor and generated-catalog-sync guidance in AGENTS.md - #25943

Merged
davsclaus merged 1 commit into
mainfrom
quick-fix/agents-md-adoc-anchor-guidance
Aug 31, 2026
Merged

chore: document adoc anchor and generated-catalog-sync guidance in AGENTS.md#25943
davsclaus merged 1 commit into
mainfrom
quick-fix/agents-md-adoc-anchor-guidance

Conversation

@davsclaus

Copy link
Copy Markdown
Contributor

Summary

  • Adds two AI-agent guidelines to the "Documentation Conventions" section of AGENTS.md:
    1. Avoid explicit [[anchor]] blocks before headings — AsciiDoc already auto-generates an id (_-prefixed) from the heading text, and an explicit anchor silently diverges from that, breaking xref: links that expect the auto-generated id.
    2. Editing a component's src/main/docs/*.adoc requires regenerating the mirrored copy under catalog/camel-catalog/src/generated/resources/.../docs/, or CI's "uncommitted changes" check fails — this applies to doc-only edits too, not just code-driven metadata changes.
  • Prompted by fixing a broken structured_error_exchange_properties anchor across several AI component docs, and a follow-up PR (chore: regenerate catalog docs for structured_error_exchange_properties anchor fix #25941) to regenerate the catalog copies that were missed the first time.

Claude Code on behalf of davsclaus

🤖 Generated with Claude Code

…ENTS.md

Prompted by a broken structured_error_exchange_properties anchor that
diverged from AsciiDoc's auto-generated heading id, plus a follow-up
where regenerating the source doc missed the mirrored copy under
catalog/camel-catalog/src/generated/resources, breaking CI's
uncommitted-changes check.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions github-actions Bot added the docs label Aug 31, 2026
@davsclaus
davsclaus merged commit 1d3dbc1 into main Aug 31, 2026
3 checks passed
@github-actions
github-actions Bot deleted the quick-fix/agents-md-adoc-anchor-guidance branch August 31, 2026 08:38

@gnodet gnodet 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.

Clean, well-motivated addition of two technically accurate guidelines to the Documentation Conventions section, prompted by a real incident where an explicit AsciiDoc anchor broke xref links and a missed catalog regeneration broke CI.

Both guidelines are directly traceable to a real incident chain and are well-worded with concrete examples. No issues found.

📋 PR Metadata

Aspect Current Suggested
Milestone (none) 4.23.0

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

Claude Code on behalf of Guillaume Nodet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants