Skip to content

chore: for each command, add markdown containing help text#657

Merged
harp-intel merged 4 commits intomainfrom
docs
Mar 5, 2026
Merged

chore: for each command, add markdown containing help text#657
harp-intel merged 4 commits intomainfrom
docs

Conversation

@harp-intel
Copy link
Contributor

This pull request adds automatic generation of command documentation for the perfspect tool and updates the README.md to reference these new docs. The main changes are the introduction of a Makefile target that creates Markdown documentation for each command and subcommand, and the enhancement of the README to link to these docs for easier access to command-line options and help texts.

Documentation generation and integration:

  • Added a docs Makefile target that generates Markdown documentation for all main commands (report, benchmark, metrics, telemetry, flamegraph, lock, config) and selected subcommands (metrics:trim, config:restore) by extracting help text from the CLI and saving it to the docs directory. (Makefile)
  • Created new Markdown files for each command and subcommand containing their help texts and usage examples: docs/perfspect.md, docs/perfspect_benchmark.md, docs/perfspect_config.md, docs/perfspect_config_restore.md, docs/perfspect_flamegraph.md. [1] [2] [3] [4] [5]

README enhancements:

  • Updated the command table in README.md to include direct links to the generated documentation for each command.
  • Replaced inline help references throughout the README with links to the relevant Markdown documentation files, improving discoverability and consistency. [1] [2] [3] [4] [5] [6] [7]

harp-intel and others added 4 commits March 5, 2026 06:34
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@harp-intel harp-intel merged commit cc134c6 into main Mar 5, 2026
5 checks passed
@harp-intel harp-intel deleted the docs branch March 5, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant