Skip to content

doc: Move Usage and Example to same header level

Rodrigo Muino Tomonari requested to merge github/fork/Trott/synopsis into master

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

Merge request reports