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.

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

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

Merged
merged 1 commit into from Jul 10, 2019

Conversation

@Trott
Copy link
Member

commented Jul 5, 2019

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.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@Trott Trott force-pushed the Trott:synopsis branch from be58aba to d48233e Jul 6, 2019

@Trott

This comment has been minimized.

Copy link
Member Author

commented Jul 6, 2019

@Trott Trott added the author ready label Jul 6, 2019

@trivikr
trivikr approved these changes Jul 9, 2019
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: #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 force-pushed the Trott:synopsis branch from d48233e to fe4d53d Jul 10, 2019

@Trott

This comment has been minimized.

Copy link
Member Author

commented Jul 10, 2019

Landed in fe4d53d

@Trott Trott merged commit fe4d53d into nodejs:master Jul 10, 2019

1 of 2 checks passed

Travis CI - Pull Request Build Errored
Details
Travis CI - Branch Build Passed
Details

@Trott Trott deleted the Trott:synopsis branch Jul 10, 2019

targos added a commit that referenced this pull request Jul 20, 2019
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: #28570
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.