Page MenuHomeFreeBSD
Files F177603569

D61592.1794825173.diff
No OneTemporary
Actions

Authored By
Unknown
Size
1 KB
Referenced Files
None
Subscribers
None

D61592.1794825173.diff
View Options

diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
--- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc
@@ -107,7 +107,7 @@
To promote consistency between the myriad authors of the FreeBSD documentation, some guidelines have been drawn up for authors to follow.
-Use American English Spelling::
+Use American English spelling::
There are several variants of English, with different spellings for the same word.
Where spellings differ, use the American English variant.
"color", not "colour", "rationalize", not "rationalise", and so on.
@@ -119,7 +119,6 @@
====
Do not use contractions::
-Do not use contractions.
Always spell the phrase out in full.
"Don't use contractions" is wrong.
+
@@ -168,7 +167,7 @@
To keep the source for the documentation consistent when many different people are editing it, please follow these style conventions.
[[one-sentence-per-line]]
-=== One sentence per line
+=== One Sentence per Line
Use Semantic Line Breaks in the documentation, a technique called "one sentence per line".
The idea of this technique is to help the users to write and read documentation.
@@ -353,7 +352,7 @@
....
[[writing-style-using-vale-commandline]]
-==== Using Vale on the command line
+==== Using Vale on the Command Line
Assuming that the `doc` repository was cloned into [.filename]#~/doc# the following commands are required to run:
@@ -370,7 +369,7 @@
======
[[writing-style-using-vale-editors]]
-==== Using Vale in editors
+==== Using Vale in Editors
link:https://vale.sh[Vale] works with major mainstream editors like package:editors/vim[], package:editors/emacs[], package:editors/vscode[].
At the moment the necessary configuration for package:editors/vim[] is described in crossref:editor-config[editor-config-vim, Vim].

File Metadata

Mime Type
text/plain
Expires
Mon, Nov 16, 10:32 AM (22 h, 40 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
41771880
Default Alt Text
D61592.1794825173.diff (1 KB)

Event Timeline