-
Notifications
You must be signed in to change notification settings - Fork 274
DOC-5937 RDI source prep checklists #2366
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
cmilesb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do kind of find these checklists a little intrusive, but I'll defer to the RDI folks if they think customers will or won't like them.
|
@cmilesb I've got a separate PR for an option to add the checklist into a page (for its AI/metadata value) but not show the interactive checklist to the user. I think I'll use this "hidden" version in the RDI pages for now |
|
@cmilesb I've added an option to add the checklist, but make it invisible to the human reader (although we are still discussing whether or not to add the interactive checklists in some places). I've added hidden checklists now in several places, including your AWS pages. Please can you have a look at the AWS pages and let me know if you think the checklists would be acceptable from a source maintenance point of view (ie, if they make the page a nightmare to maintain, then maybe we don't want them, or we want a simpler version). |
We use these checklists in some of the other doc pages and I thought it might be useful to add them to some of the RDI pages, since they often involves lots of steps to follow. AI agents love these checklists, but if you think they are too intrusive for human readers then we can maybe keep them hidden in the page, so only AI tools can see them.
Let me know what you think of this example. I'll add similar checklists to the other pages if everyone's happy with them.