-
Notifications
You must be signed in to change notification settings - Fork 1
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Documentation Update
Update the structure and flow of the getting_started.rst documentation to improve clarity and usability. Specifically:
- Reorder the examples so the smallest, fastest-running example appears first.
- For each example, show both:
- the corresponding
config.yaml - the CLI command used to run it
- the corresponding
- Include an estimated runtime for each example so users know what to expect.
- Explicitly demonstrate changing into the user’s working directory before running CodeEntropy, and clarify that output will be generated relative to that directory (rather than an arbitrary or unexpected location).
Why Is This Needed?
The current layout can be confusing for new users, particularly around execution order, expected runtimes, and where output files are generated. Reordering the examples and pairing configuration files directly with their CLI commands makes the workflow easier to follow and reduces setup friction. Adding runtime estimates helps users choose appropriate examples based on available time, while clarifying directory context
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation