From ebf2cd164158c051b8a903d495c20b9dd8ba1d0e Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 18 Jul 2020 15:08:12 -0700 Subject: [PATCH] doc: add statement of purpose to documentation style guide PR-URL: https://github.com/nodejs/node/pull/34424 Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca Reviewed-By: Anna Henningsen --- doc/guides/doc-style-guide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index c4e1f0aa36a371..4813c4a1fbd282 100644 --- a/doc/guides/doc-style-guide.md +++ b/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`.