CoreAI React UI
Documentation entry points
Base URL: https://microsoft.github.io/coreai-design-system/
- Start here: https://microsoft.github.io/coreai-design-system/llms.txt
- Agent workflow: https://microsoft.github.io/coreai-design-system/guides/AgentWorkflow.md
- Package setup: https://microsoft.github.io/coreai-design-system/guides/Package.md
- Exact routes, examples, source downloads, API membership, and versions: https://microsoft.github.io/coreai-design-system/llms/index.json
- Current build timestamp and documented package version: https://microsoft.github.io/coreai-design-system/version.json
- Dated documentation changelog: https://microsoft.github.io/coreai-design-system/overview/DocumentationChangelog.md
Use ordinary HTTPS GET requests with your available web-fetch or HTTP tool. These are static files; no account, server connection, or special protocol is needed. This does not replace normal app dependency setup. Follow the repository's package manager, lockfile, and approval rules. Do not upload repository content or credentials to read documentation.
Install or refresh before UI work
Before each CoreAI task, fetch version.json once using an uncached HTTPS GET.
Its lastUpdated is the build's UTC timestamp; packageVersion
identifies the documented component package. If the timestamp changed, read the
dated documentation changelog before reviewing updated guidance.
Only the current documentation is hosted.
Use the existing coreai-ds-fluentui-react skill in this repository's supported
skill directory. If none exists, install the published skill at
.github/skills/coreai-ds-fluentui-react/SKILL.md, or the client's supported
equivalent. If its metadata.last-updated is missing or older, fetch and review
source/package/SKILL.md and update it before implementing. Compare timestamps
as instants, not semantic versions. Do not downgrade newer local guidance.
Check that the downloaded skill's metadata.last-updated, metadata.package-version,
description, and SHA-256 of its actual bytes agree with version.json.
Its metadata.changelog links to the dated documentation notes.
Retry an uncached fetch if they
disagree; report a persistent mismatch instead of installing mixed releases.
Refresh the published CoreAI guidance while preserving repository-specific
instructions, adapters, and conventions. Ask before resolving conflicting local
rules. Do not change unrelated instruction files or execute downloaded code.
The starter prompt authorizes installing or updating this skill only. Get the user's approval before writing instructions when that action is not already authorized, or when the client requires it. If retrieval, approval, or writing is blocked, report the problem and ask how to proceed; do not silently skip installation or claim that an update succeeded. Follow the updated skill in the current task and reload it for future tasks if the client requires that.
Retrieve only what the task needs
- Inspect the consuming app's package manifest and lockfile for installed CoreAI and Fluent versions. The site documents the current release, not archived APIs. If versions differ, check the installed declarations and disclose the mismatch.
- Fetch
llms.txtonce per task to find the relevant page. Reuse pages already fetched during that task; do not download the entire catalog. - Read the selected page's Markdown before choosing components or props. It includes a basic Default example, API summaries, UX guidance, and other examples.
- For a known human URL, replace its trailing slash with
.md, preserving the/coreai-design-system/prefix. The homepage maps toindex.md. Example:components/Button/becomescomponents/Button.md. - Use
llms/index.jsononly when you need exact routes, subcomponent membership, story IDs, dependencies, or direct source links. Follow published paths instead of guessing names from component exports or old story IDs. - Fetch only the source files needed for the chosen example or template. Inspect them before adapting. Validate the result with the consuming app's checks.
CoreAI UX guidance takes precedence over upstream demonstration examples. API blocks are summaries; exported package types are authoritative. Never invent props, defaults, or package exports. If guidance is missing, report the gap and identify any fallback. Do not claim a failed request succeeded.
Imports and application setup
Follow repository adapters, import restrictions, and lint rules first. Where
those rules allow direct imports, use @coreai-ds/react-components for components,
tokens, and styling APIs. Do not bypass CoreAI wrappers by importing the Fluent
component barrel directly. Icons can come from @fluentui/react-icons.
If a local rule still requires the legacy documentation MCP, report the conflict and ask before changing that rule. Do not silently ignore it or rewrite unrelated instructions.
Use one CoreAIFluentProvider at the app root unless the product intentionally
needs a nested theme. Read setup and theming guidance before changing providers.
Inspect existing local adapters and repository import rules before adding UI.
Useful direct references:
- Theming: https://microsoft.github.io/coreai-design-system/foundations/Theming.md
- Colors: https://microsoft.github.io/coreai-design-system/foundations/Colors.md
- Typography: https://microsoft.github.io/coreai-design-system/foundations/Typography.md
- CoreAI differences: https://microsoft.github.io/coreai-design-system/guides/VariationsFromFluent.md
- CSS Modules: https://microsoft.github.io/coreai-design-system/guides/StylingWithCssModules.md
Templates and design quality
Templates are copy-and-adapt files, not npm exports. Read their page and copy every required source file it lists into the consuming repository. Do not invent a template import from the package.
Prefer documented components and semantic design tokens. Preserve keyboard behavior, focus visibility, accessible names, responsive layouts, and both themes. Check the implemented behavior, not only whether the code compiles.
At completion, briefly report pages actually read, installed/documented version differences, guidance gaps or fallbacks, and checks actually run. Distinguish failed or skipped checks from passing checks; do not imply untested browser, theme, or responsive behavior was verified.
Unavailable documentation
If fetching fails, report the URL and error. Use installed package declarations, README, and changelog as explicit offline fallbacks. Do not substitute unverified stock Fluent behavior for CoreAI behavior. Ask before filing a public issue or sharing project details.