Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Move Usage and Example to same header level #28570

Merged
merged 1 commit into from
Jul 10, 2019
Merged

doc: Move Usage and Example to same header level #28570

merged 1 commit into from
Jul 10, 2019

Commits on Jul 10, 2019

  1. 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: nodejs#28570
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
    @Trott
    Trott committed Jul 10, 2019
    Configuration menu
    Copy the full SHA
    fe4d53d View commit details
    Browse the repository at this point in the history