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

Docs: Update documenation contributors guide with doc types #36689

Merged
merged 2 commits into from
Dec 3, 2021
Merged

Docs: Update documenation contributors guide with doc types #36689

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b93032
Update documentation contributors guide with types
mkaz Nov 20, 2021
12f76bc
Markdown linting
mkaz Nov 21, 2021
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
Prev Previous commit
Markdown linting
  • Loading branch information
@mkaz
mkaz committed Nov 21, 2021
commit 12f76bcae91cccef545f58e54bbc05b09aee20e9
15 changes: 6 additions & 9 deletions docs/contributors/documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ See [the Git Workflow](/docs/contributors/code/git-workflow.md) documentation fo

### Handbook structure

The handbook is organized into four sections based on the functional types of documents. [The Documentation System](https://documentation.divio.com/) does a great job explaining the needs and functions of each type, but in short they are:
The handbook is organized into four sections based on the functional types of documents. [The Documentation System](https://documentation.divio.com/) does a great job explaining the needs and functions of each type, but in short they are:

- **Getting started tutorials** - full lessons that take learners step by step to complete an objective, for example the [create a block tutorial](/docs/getting-started/create-block/README.md).
- **How to guides** - short lessons specific to completing a small specific task, for example [how to add a button to the block toolbar](/docshow-to-guides/format-api/README.md).
- **Reference guides** - API documentation, purely functional descriptions,
- **Explanations** - longer documentation focused on learning, not a specific task.
- **Getting started tutorials** - full lessons that take learners step by step to complete an objective, for example the [create a block tutorial](/docs/getting-started/create-block/README.md).
- **How to guides** - short lessons specific to completing a small specific task, for example [how to add a button to the block toolbar](/docshow-to-guides/format-api/README.md).
- **Reference guides** - API documentation, purely functional descriptions,
- **Explanations** - longer documentation focused on learning, not a specific task.

### Update a document

Expand Down Expand Up @@ -110,9 +110,7 @@ The Block Editor handbook supports the same [notice styles as other WordPress ha
The recommended way to implement in markdown is to use the raw HTML and `callout callout-LEVEL` classes. For example:

```html
<div class="callout callout-info">
This is an **info** callout.
</div>
<div class="callout callout-info">This is an **info** callout.</div>
```

The following classes are available: `info`, `tip`, `alert`, `warning`
Expand All @@ -133,7 +131,6 @@ This is an **alert** callout.
This is a **warning** callout.
</div>


### Editor config

You should configure your editor to use Prettier to auto-format markdown documents. See the [Getting Started documentation](/docs/contributors/code/getting-started-with-code-contribution.md) for complete details.
Expand Down