docs: provide md files for openapi site#2562
Merged
joyenjoyer merged 1 commit intoJun 10, 2026
Merged
Conversation
|
Visual regression report✅ No changes.
Baselines come from the |
matyasf
requested changes
May 20, 2026
| @@ -0,0 +1,7 @@ | |||
| ## What is Instructure UI? | |||
|
|
|||
| Instructure UI (or **InstUI**) is the React component library and design system that powers Instructure's products, including Canvas LMS. It ships as a [Lerna](https://lerna.js.org/) monorepo of 100+ packages (one per component, plus theme, icon, and utility packages) and is published under the `@instructure/*` scope on npm. For most consumers, the easiest way to get started is to add the [`@instructure/ui`](https://instructure.design/#usage) meta-package, wrap your app in the settings provider, and start rendering components. There are no global stylesheets to import and no CSS classes to memorize: styling is handled internally with [Emotion](https://emotion.sh/), and every component is themeable through the same provider. | |||
Collaborator
There was a problem hiding this comment.
It ships as a Lerna monorepo of 100+. => It ships as a monorepo of 100+
Its not important that we use Lerna internally
|
|
||
| We aim to make InstUI easy to use, easy to learn, and free from bloat. For this reason every component is built on a few shared principles. All components target [WCAG 2.1 AA](https://instructure.design/#accessibility) (and AAA when paired with the [canvas-high-contrast](https://instructure.design/#canvas-high-contrast) theme), support RTL languages, work with VoiceOver, NVDA and JAWS, and never hardcode user-facing strings, so every label is localizable. | ||
|
|
||
| Out of the box InstUI ships with two themes, [`canvas`](https://instructure.design/#canvas) (the default, 4.5:1 contrast) and [`canvasHighContrast`](https://instructure.design/#canvas-high-contrast) (7.0:1 contrast), along with a multi-layered color system built from `primitives`, `contrasts`, and curated `UI` tokens, so designers and developers can pick the right level of abstraction for the job. Theming is scoped: you can swap themes for an entire app, or for a subtree, by nesting another settings provider. For teams using AI coding agents, the whole component library is also available as a single downloadable archive of markdown at [instructure.design/markdowns/documentation.zip](https://instructure.design/markdowns/documentation.zip), with an `llms.txt` catalog at [instructure.design/llms.txt](https://instructure.design/llms.txt). For everyone else, the rendered docs at [instructure.design](https://instructure.design) are the best place to start. |
Collaborator
There was a problem hiding this comment.
We will ship very soon with 4 themes. Also I would not mention the multi-layered color system, its a detail
git-nandor
approved these changes
May 20, 2026
joyenjoyer
force-pushed
the
INSTUI-5011-add-inst-ui-overview-to-documentation-portal
branch
from
a8e9266 to
115b154
Compare
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
matyasf
approved these changes
Jun 1, 2026
joyenjoyer
deleted the
INSTUI-5011-add-inst-ui-overview-to-documentation-portal
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
OpenAPI developers need two
.mdfiles from us (one introducing our product and another toc file -> all the toc files are merged into a big list by their built system) that can be put on the documentation site.