Skip to content

Commit

Permalink
docs: Improve documentation structure
Browse files Browse the repository at this point in the history
In addition to some rephrasing and polishing of the wording of the
documentation, overhaul the structure. Remove the dedicated pages
showing how to run each of the CLI commands, instead merging them into
a section on the most closely related page. Create a new page for the
`run` subcommand that describes all its possible modes, but link to
a separate page for detailed descriptions about "live" mode. Move the
"live mode" page into the reporters section, since it's essentially
a reporter.
  • Loading branch information
godlygeek authored and pablogsal committed Apr 20, 2022
1 parent 0e30ff1 commit 9551b16
Show file tree
Hide file tree
Showing 18 changed files with 510 additions and 498 deletions.
37 changes: 0 additions & 37 deletions docs/cli/flamegraph.rst

This file was deleted.

26 changes: 0 additions & 26 deletions docs/cli/live.rst

This file was deleted.

37 changes: 0 additions & 37 deletions docs/cli/run.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/cli/stats.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/cli/summary.rst

This file was deleted.

32 changes: 0 additions & 32 deletions docs/cli/table.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/cli/tree.rst

This file was deleted.

Loading

0 comments on commit 9551b16

Please sign in to comment.