Opened 3 hours ago
#19385 assigned enhancement
Improving AI use of documentation with HTML semantic tags
| Reported by: | Greg Couch | Owned by: | Elaine Meng |
|---|---|---|---|
| Priority: | low | Milestone: | |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | chimera-programmers | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
The documentation could be enhanced to make it easier for AI agents and other software to understand the meaning of the parts of the documentation with semantic tags. In general, that means not using <div>, <pre>, <b>, et.al. when more expressive tags are available. In the case where there isn't an appropriate preexisting HTML semantic tag, we could associate a css class that has meaning.
For example, the <nav> semantic tag listed in ​https://www.w3schools.com/html/html5_semantic_elements.asp would let the AI agent skip over that part of the page and help screen readers.
Also look at ​https://www.w3schools.com/html/html_computercode_elements.asp. Clearly identifying what is typed on the command line with <kbd> and the log output with <samp> instead of <pre> would be very helpful. For example, instead of "<b>wobble</b>", it could be "<kbd style='command'>wobble</kbd>". And there would be css for 'command' that would do the bolding.