build: generate llms.txt and markdown files of the documentation for optimal AI consumption

[ToMESSKa]

INSTUI-4701

ISSUE:

• InstUI lacks an ai-friendly documentation

TEST PLAN:

• check https://instructure.design/pr-preview/pr-2109/llms.txt it should open contain all necessary sections, components and guides and each link should be followed by a short summary of that guide/component
• the links in the llms.txt should redirect to existing markdown files, these should include every information and in the case of components, examples, prop tables and usage, in the case of sub-components like Tabs.Panel in Tabs, the prop table should include the props of the sub-component
• check the structure and section hierarchy of the llms.txt file and the markdown files, they should be error-free
• check https://instructure.design/pr-preview/pr-2109/markdowns/documentation.zip , it should download a compressed folder, the folder should contain all files about the necessary sections, components and guides, and the files should include every information and in the case of components, examples, prop tables and usage
• the compressed folder should contain and INDEX.md file, which should point to the files in the compressed folder, the INDEX.dm should contain all necessary sections, components and guides and each link should be followed by a short summary of that guide/component
• check the updated sections in 'Getting started' and 'Contributor guides'

[github-actions]

PR Preview Action v1.6.2
Preview removed because the pull request was closed.
2025-09-26 11:56 UTC

[ToMESSKa]

this is for testing purposes, it should be 'https://instructure.design/markdowns/'

[matyasf]

Very nice work!! There are a couple of smaller issues what needs to be resolved (see my comments)

Also we should think about (its a future ticket) what we do with internal links. Now they are anchor link,s AI might have a hard time following them in the .md files..

[matyasf]

there is one small change needed for type parsing, see my comment. Also dont forget to use the proper link here: https://github.com/instructure/instructure-ui/pull/2109/files#diff-1faeaf1714eeac41ba8eccaff204c2f140f9adc2d5e6964a357723ba7ccde096R163

[HerrTopi]

Nice work, seems to be working fine. I'm not sure if the AI components section will confuse the llms or not, but I don't think it should be added as an exeption.

Approved