Skip to content

build: generate AI docs from latest version#2640

Open
ToMESSKa wants to merge 1 commit into
masterfrom
INSTUI-5092-update-markdown-files-for-ai-so-it-uses-the-newest-version
Open

build: generate AI docs from latest version#2640
ToMESSKa wants to merge 1 commit into
masterfrom
INSTUI-5092-update-markdown-files-for-ai-so-it-uses-the-newest-version

Conversation

@ToMESSKa

@ToMESSKa ToMESSKa commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

INSTUI-5092

ISSUE:

  • the AI documentation the build generates (llms.txt + the per-component markdowns/*.md) was being built using the default export, which still resolves to the older stable v11_6, so the docs described outdated props/examples instead of the latest v11_7 / v2 components

TEST PLAN:

  • build the docs from the repo using pnpm run dev
  • check the a few component's markdown files in packages/__docs__/__build__/markdowns and confirm they reflect the v2 version of the component e.g: in Link.md isWithinText is removed (compared to v1) or in Avatar.md the first example of Avatar uses accent colors (compared to v1)
  • check a versioned component's file in packages/__docs__/__build__/markdowns, it should snow the versioned import like import { Alert } from '@instructure/ui-alerts/v11_7' under "Import the component" header:
  • check a non-versioned component's file in packages/__docs__/__build__/markdowns, it should snow a plain import likeimport { Dialog } from '@instructure/ui-dialog' under the "Import the component" header:
  • check packages/__docs__/__build__/llms.txt the file should include "All component documentation below always reflects the latest InstUI version noted above.." warning and "Component versioning" should be there under "Guides"

@ToMESSKa ToMESSKa self-assigned this Jul 15, 2026
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://instructure.design/pr-preview/pr-2640/

Built to branch gh-pages at 2026-07-15 11:18 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions

Copy link
Copy Markdown

Visual regression report

No changes.

Status Count
Unchanged 32
Changed 0
New 0
Removed 0

📊 View full report

Baselines come from the visual-baselines branch. They refresh on every merge to master.

github-actions Bot pushed a commit that referenced this pull request Jul 15, 2026
@ToMESSKa
ToMESSKa requested a review from git-nandor July 15, 2026 11:54
)
}
generateAIAccessibleMarkdowns(
latestVersionDocsDir,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

generateAIAccessibleMarkdowns is called without await, so any error would bypass the buildDocs error wrapper as an unhandled rejection.

@git-nandor

Copy link
Copy Markdown
Contributor

😄 I think there is a bit more 'snow' in this test plan than we actually need 🌨️ ❄️

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