Skip to content

LLMs can parse AsciiDoc callouts like any other block of text#567

Merged
IngridT1 merged 1 commit intoredhat-documentation:mainfrom
aireilly:fix
Jan 13, 2026
Merged

LLMs can parse AsciiDoc callouts like any other block of text#567
IngridT1 merged 1 commit intoredhat-documentation:mainfrom
aireilly:fix

Conversation

@aireilly
Copy link
Member

@aireilly aireilly commented Jan 7, 2026

Fixes a small inaccuracy.

rh-pre-commit.version: 2.3.2
rh-pre-commit.check-secrets: ENABLED
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

Preview Build

A preview of this PR has been built and deployed.

Preview URL: https://redhat-documentation.github.io/supplementary-style-guide/pr-567/main.html

This preview will be updated automatically when new commits are pushed to this PR.


This comment is automatically generated by the PR Preview workflow.

@IngridT1
Copy link
Collaborator

@aireilly This is what @Preeticp originally said about this PR before I approved it, so I think this subject is more nuanced than your change reflects:

Callouts do not work for AI: Because callouts are not supported in DITA, (and we're not making changes to DITA-OT) there isn't semantic markup for an AI agent to understand what is happening or to output that semantic markup properly.

So rather than removing the info about AI, we should rewrite it. @Preeticp do you have a suggestion for rewriting it?

@aireilly
Copy link
Member Author

aireilly commented Jan 12, 2026

@aireilly This is what @Preeticp originally said about this PR before I approved it, so I think this subject is more nuanced than your change reflects:

Callouts do not work for AI: Because callouts are not supported in DITA, (and we're not making changes to DITA-OT) there isn't semantic markup for an AI agent to understand what is happening or to output that semantic markup properly.

So rather than removing the info about AI, we should rewrite it. @Preeticp do you have a suggestion for rewriting it?

The information is incorrect though, my suggestion is a rewrite to remove an inaccuracy.

@IngridT1
Copy link
Collaborator

Sure, @aireilly, how would you rewrite it?

@aireilly
Copy link
Member Author

Sure, @aireilly, how would you rewrite it?

Callouts are not supported by DITA. Callouts can easily and reliabily be parsed by LLMs, so not sure why we'd have to add anything else.

@IngridT1 IngridT1 self-requested a review January 13, 2026 21:35
Copy link
Collaborator

@IngridT1 IngridT1 left a comment

Choose a reason for hiding this comment

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

@aireilly explained the reasoning behind this. I approve it.

@IngridT1 IngridT1 merged commit 5334f65 into redhat-documentation:main Jan 13, 2026
2 checks passed
github-actions bot added a commit that referenced this pull request Jan 13, 2026
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.

2 participants