chore: document adoc anchor and generated-catalog-sync guidance in AGENTS.md - #25943
Conversation
…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>
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
gnodet
left a comment
There was a problem hiding this comment.
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
Summary
AGENTS.md:[[anchor]]blocks before headings — AsciiDoc already auto-generates an id (_-prefixed) from the heading text, and an explicit anchor silently diverges from that, breakingxref:links that expect the auto-generated id.src/main/docs/*.adocrequires regenerating the mirrored copy undercatalog/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.structured_error_exchange_propertiesanchor 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