-
Notifications
You must be signed in to change notification settings - Fork 76
Open
Description
We can not use callouts in code blocks for the following reasons:
- Callouts are not supported in DITA: Unlike AsciiDoc, DITA does not support callouts as a method to add annotations to specific lines in verbatim blocks.
- 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.
- Callouts are not used by our competitors: See: Competitor analysis on callouts and code blocks
Currently in our documentation we use callouts for the following use cases:
-
Use Case 1: Add relevant additional information about a single line of code, element, or variable.
-
Use Case 2: Add relevant additional information about multiple lines of code, elements, or explain the structure of a sample YAML file
-
Use Case 4: Notes about a particular line in the code
We need to ensure that the SSG has updated guidance on replacing callouts with simple sentences, bulleted/unordered lists, definition lists or Admonition style as appropriate depending on context.
Metadata
Metadata
Assignees
Labels
No labels