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.

Sign up for GitHub

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

Jump to bottom

chore(#5): update documantation #275

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

chore(#5): update documantation #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/content/guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,12 @@ Druxt is a framework for building Fully Decoupled Drupal and Nuxt.js application

Druxt is built on two frameworks, Drupal and Nuxt.js, both with their own modules which can be used alongside Druxt modules.

Druxt modules provide Nuxt modules, plugins, components and more to bridge the gap and make Decoupled development easier.
Druxt modules provide the following, and more, to bridge the gap and make decoupled development easier:
- Nuxt modules
- Nuxt plugins
- Vue components

Finding modules:
- For Druxt modules, see the [Druxt modules list](/modules).
- For Drupal modules, see the [Drupal modules list](https://www.drupal.org/project/project_module).
- For Nuxt modules, see the [Nuxt modules list](https://modules.nuxtjs.org/).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

# Getting started with Druxt.js

> Druxt is a Fully Decoupled Drupal framework.

Expand Down
1 change: 1 addition & 0 deletions docs/content/guide/storybook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


> Druxt provides zero-config, auto generated Storybook integration with live data.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/guide/theming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- [Default template injection](#default-template)

* * *
Expand Down Expand Up @@ -51,7 +51,7 @@ If there are no matching component names, a default `DruxtWrapper` component wil

Most Druxt modules can have the default template overridden, allowing for full control of the default slot rendering.

The available data provided to the template scope is deteremined by the relevant module.
The available data provided to the template scope is determined by the relevant module.

```vue
<DruxtEntity>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/modules/schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Schema
description: Drupal Content Entity schema generator for Druxt with support for View and Form displays.
---

The Schema module uses the Drupal's Display mode configuration JSON:API data to build a Vuex Schema store.
The Schema module uses Display mode configuration from Drupal's JSON:API data to build a Vuex Schema store.

## Features

Expand Down