Skip to content

[Docs]: Improve Getting Started Documentation Flow and Examples #270

@harryswift01

Description

@harryswift01

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
  • 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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions