From fe4d53df512edcd046f002b1b78c47a687f0fad1 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 5 Jul 2019 16:35:19 -0700 Subject: [PATCH] doc: move Usage and Example to same header level Having Example under Usage in synopsis.md is misleading. That suggests that the examples will be examples of the CLI usage, but the example section is mostly about writing a simple web server. Ideally, the Usage section should be moved to cli.md and the Example section should constitute a Getting Started or Quick Start page. But for now, make them equals under a combined header so that the Table of Contents and the header/layout of the page is not confusing or misleading. PR-URL: https://github.com/nodejs/node/pull/28570 Reviewed-By: Anna Henningsen Reviewed-By: Roman Reiss Reviewed-By: Trivikram Kamat --- doc/api/synopsis.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 5c4cb820e4d..c296ffb0fa4 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,4 +1,6 @@ -# Usage +# Usage & Example + +## Usage