diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-07-06 02:35:19 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-07-10 05:45:20 +0300 |
| commit | fe4d53df512edcd046f002b1b78c47a687f0fad1 (patch) | |
| tree | 305497dfe56afc9dcc4f9bd37d5b98d532632f65 /doc/api/synopsis.md | |
| parent | 7e69bcef1afce41db96fb0b227b62d48bf435781 (diff) | |
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 <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/synopsis.md')
| -rw-r--r-- | doc/api/synopsis.md | 4 |
1 files changed, 3 insertions, 1 deletions
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 <!--introduced_in=v0.10.0--> <!--type=misc--> |