Skip to content

Commit 87fd13f

Browse files
committed
A few worth edits
1 parent 6d2af24 commit 87fd13f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

brand/user-docs-page-template.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ This page provides a quick-start template for new documentation pages. Be sure t
1212

1313
**On this page**:
1414

15-
* Table of contents
15+
* Contents
1616
{:toc}
1717

18-
## Template markup
18+
## Using the template
1919

2020
To use the template:
2121

22-
1) Create a new Markdown page (having file extension, *.md*).
22+
1) Create a new Markdown page having file extension, *.md*.
2323

24-
2) Save it in the appropriate directory location using one of these file-name patterns, as required:
24+
2) Save it in the appropriate directory location using one of the following file-name patterns, respectively:
2525

26-
* If it’s a page for a new Textpattern tag, use this underscore pattern: *file_name_for_page.md*.
27-
* For all other pages in the documentation website, use this hyphenated pattern: *file-name-for-page.md*.
26+
* If a tag page in the Tag Reference, use underscores: *file_name_for_page.md*.
27+
* For all other pages in user docs, use hyphens: *file-name-for-page.md*.
2828

2929
3) Copy the following block of code (the minimum template markup) and paste it in your new blank page. Adjust to your needs.
3030

@@ -72,9 +72,9 @@ Normal text.
7272
```
7373

7474

75-
## Template explanation
75+
## Explanation
7676

77-
A quick breakdown of the markup elements.
77+
Elaboration on each template element.
7878

7979
### Metadata
8080

@@ -107,8 +107,8 @@ As example, the metadata block for the user documentation guidelines:
107107
layout: document
108108
category: brand
109109
published: true
110-
title: Textpattern user documentation guidelines
111-
description: Guidelines for contributions to Textpattern CMS user documentation.
110+
title: Development guidelines for Textpattern documentation
111+
description: Guidelines for the development of Textpattern user documentation.
112112
---
113113
```
114114

@@ -137,7 +137,7 @@ The contents list begins with a consistent lead line, followed by the Kramdown s
137137
```
138138
**On this page:**
139139
140-
* Table of contents
140+
* Contents
141141
{:toc}
142142
```
143143

0 commit comments

Comments
 (0)