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

chore(#5): update documantation #275

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

BrianGilbert
Copy link
Member

@BrianGilbert BrianGilbert commented Sep 23, 2021

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. (PR: #)
  • I have added tests to cover my changes (if not applicable, please state why)
  • All new and existing tests are passing.

Screenshots/Media:

@changeset-bot
Copy link

changeset-bot bot commented Sep 23, 2021

⚠️ No Changeset found

Latest commit: b2dfec4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented Sep 23, 2021

Codecov Report

Merging #275 (b2dfec4) into develop (d723f58) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #275   +/-   ##
========================================
  Coverage    96.34%   96.34%           
========================================
  Files           88       88           
  Lines         2765     2765           
  Branches       566      566           
========================================
  Hits          2664     2664           
  Misses          91       91           
  Partials        10       10           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d723f58...b2dfec4. Read the comment docs.

@@ -3,7 +3,7 @@ title: Getting started with Druxt.js
weight: -9
---

### Getting started with Druxt.js
Copy link
Member

Choose a reason for hiding this comment

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

I specifically set this indentation to this level to make it more consistent with other parts of the site.

It should actually be remove entirely though, and dealt with on the Nuxt page component instead:

@@ -2,6 +2,7 @@
title: Storybook
weight: -5
---
# Storybook
Copy link
Member

Choose a reason for hiding this comment

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

See above comment

@@ -6,7 +6,7 @@ weight: -6
# Theming

Druxt components can be themed using two primary methods:
- [Druxt wrapper components](#druxtwrapper)
- [DruxtWrapper components](#druxtwrapper)
Copy link
Member

Choose a reason for hiding this comment

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

I think Druxt wrapper component makes more sense, as it's a Wrapper component provided by Druxt.

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