Skip to content

Commit 9be1111

Browse files
Trotttargos
authored andcommitted
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 <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent a8b094c commit 9be1111

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/synopsis.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Usage
1+
# Usage & Example
2+
3+
## Usage
24

35
<!--introduced_in=v0.10.0-->
46
<!--type=misc-->

0 commit comments

Comments
 (0)