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:
- Add explicit documentation for each script in the scripts/ directory
- Document all CLI parameters and their valid values
- List available simulation scenarios and their purposes
- Document dashboard generation options and templates
- Add examples of typical usage
Impact:
Better script documentation will make the repository more accessible to new users and reduce the learning curve.
Issue Description
Several scripts lack comprehensive documentation about their purpose and command-line parameters.
Current issues:
claude-metrics-simulator.scm(Guile script)generate_dashboards.pyaren't documented in README.orgmake simulate-scenario SCENARIO=namedon't list valid valuesProposed Changes:
Impact:
Better script documentation will make the repository more accessible to new users and reduce the learning curve.