Skip to content

Commit 66c66b7

Browse files
committed
docs: provide md files for openapi site
1 parent 33e3bab commit 66c66b7

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

openapi/instui.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## What is Instructure UI?
2+
3+
Instructure UI (or **InstUI**) is the React component library and design system that powers Instructure's products, including Canvas LMS. It contains 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.
4+
5+
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.
6+
7+
Out of the box InstUI ships with 4 themes. 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.

openapi/toc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- [Instructure UI](instui.md)

0 commit comments

Comments
 (0)