mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
doc: add statement of purpose to documentation style guide
PR-URL: https://github.com/nodejs/node/pull/34424 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
1 parent
00823f2967
commit
ebf2cd1641
1 file changed
+9
-1
@@ -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`.
|
||||
|
||||
Reference in new issue
Block a user