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

Add design principles #14

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add design principles #14

wants to merge 2 commits into from

Conversation

carriependo
Copy link

Added design principles as per confluence document created originally by Holly Reynolds and Joe Dreimann

  • Adding a note to say there is a missing image "images/customers-heroes.png" which I couldn't see on my branch, but just wanted to check after a push as I know this has been an issue previously.

@neillrobson neillrobson self-requested a review July 1, 2024 15:06
Copy link
Collaborator

@neillrobson neillrobson left a comment

Choose a reason for hiding this comment

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

I'll see if I can resolve the merge conflict here in Github so that the lookaside is built. Let me know if you have any questions about my other comments!

src/components/SidebarNav.vue Outdated Show resolved Hide resolved
<hr>

<h2> Dos and Don’ts</h2>
<p><b>DO:</b> consider these principles when actively making your design decisions. This is the best time to leverage them.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: I think that <strong> is preferred over <b> nowadays.

@@ -14,6 +14,10 @@ const routes = [
path: '/getting-started',
component: () => import('@/views/HomePage.vue')
},
{
path: '/design-principles',
Copy link
Collaborator

Choose a reason for hiding this comment

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

This'll work perfectly fine for a top-level page! However, if you prefer MDX, you could always create a directory content/design-principles with an index.mdx file in there and just write Markdown. That strategy would remove the need to write a custom Vue component, and also eliminate the need to add the router entry manually. Just a callout!

Copy link
Collaborator

Choose a reason for hiding this comment

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

image

The linter prefers that we always give Vue components multi-word names, such as DesignPrinciples. It's probably not a lint rule we need to keep as an error, but for the time being the quickest fix (to get the build/lookaside running) would be to just rename this I think!

@@ -164,6 +58,7 @@ const NAV_ITEMS = [
{ title: 'Release Notes' },
{ title: 'About Prism' },
{ title: 'Getting Started', path: '/getting-started' },
{ title: 'Design Principles Toolkit', path: '/design-principles' },
Copy link
Collaborator

Choose a reason for hiding this comment

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

Went ahead and resolved this merge conflict.

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