Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New foundation page for errors and other minor changes #97

Merged
merged 9 commits into from
Sep 2, 2020

Conversation

jtamiace
Copy link
Member

@jtamiace jtamiace commented Sep 1, 2020

Main submission is a new foundation page for error patterns.
Reference: https://docs.google.com/document/d/1Y-lCHIolecpf3XgCnRlGRs08cVrv6hc7dSMAwxr_HI8/edit

Other changes

  • Added placeholder pages to table of contents from design system tracker
  • Small formatting update to the design principles page
  • Top-aligned DocsDoNot container across all pages

New errors page

screencapture-localhost-4000-errors-2020-09-01-14_27_39

Updated styling for principles

Screen Shot 2020-09-01 at 2 27 34 PM

@jtamiace jtamiace added the category: docs content Design patterns and component usage label Sep 1, 2020
Copy link
Contributor

@indirectlylit indirectlylit left a comment

Choose a reason for hiding this comment

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

nice job! left a few notes

docs/common/DocsDoNot.vue Outdated Show resolved Hide resolved
docs/common/DocsDoNot.vue Show resolved Hide resolved
docs/gitBranch.js Outdated Show resolved Hide resolved
docs/pages/errors/index.vue Outdated Show resolved Hide resolved
Inline error messages
</h3>
<p>
Place inline error messages in close proximity to where the error occurred. This can be an icon only, or icon and text. When paired with text, use <code>KLabeledIcon</code>
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't work until we add a docs page for it, but when we do we'll be able to use DocsInternalLink with code attribute:

<DocsInternalLink code href="/klabeledicon">KLabeledIcon</DocsInternalLink>

docs/pages/errors/index.vue Outdated Show resolved Hide resolved
docs/common/DocsDoNot.vue Show resolved Hide resolved
@indirectlylit indirectlylit merged commit 4be5967 into learningequality:v0.2.x Sep 2, 2020
@jtamiace jtamiace deleted the errors branch March 2, 2021 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs content Design patterns and component usage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants