Skip to content

Improve documentation for scripts and CLI parameters #16

Description

@aygp-dr

Issue Description

Several scripts lack comprehensive documentation about their purpose and command-line parameters.

Current issues:

  • Limited documentation for claude-metrics-simulator.scm (Guile script)
  • CLI parameters for generate_dashboards.py aren't documented in README.org
  • Parameters for commands like make simulate-scenario SCENARIO=name don't list valid values
  • Missing documentation about script interdependencies

Proposed Changes:

  1. Add explicit documentation for each script in the scripts/ directory
  2. Document all CLI parameters and their valid values
  3. List available simulation scenarios and their purposes
  4. Document dashboard generation options and templates
  5. Add examples of typical usage

Impact:

Better script documentation will make the repository more accessible to new users and reduce the learning curve.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions