Skip to content

Commit 8ee83a9

Browse files
Trottaddaleax
authored andcommitted
doc: add statement of purpose to documentation style guide
PR-URL: #34424 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 6054e21 commit 8ee83a9

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

doc/guides/doc-style-guide.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Style Guide
1+
# Documentation style guide
2+
3+
This style guide helps us create organized and easy-to-read documentation. It
4+
provides guidelines for organization, spelling, formatting, and more.
5+
6+
These are guidelines rather than strict rules. Content is more important than
7+
formatting. You do not need to learn the entire style guide before contributing
8+
to documentation. Someone can always edit your material later to conform with
9+
this guide.
210

311
* Documentation is in markdown files with names formatted as
412
`lowercase-with-dashes.md`.

0 commit comments

Comments
 (0)