Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc: add statement of purpose to documentation style guide
PR-URL: nodejs#34424
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
Trott committed Jul 21, 2020
1 parent 00823f2 commit ebf2cd1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion doc/guides/doc-style-guide.md
@@ -1,4 +1,12 @@
# Style Guide
# Documentation style guide

This style guide helps us create organized and easy-to-read documentation. It
provides guidelines for organization, spelling, formatting, and more.

These are guidelines rather than strict rules. Content is more important than
formatting. You do not need to learn the entire style guide before contributing
to documentation. Someone can always edit your material later to conform with
this guide.

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

0 comments on commit ebf2cd1

Please sign in to comment.