Skip to content

Conversation

@harryswift01
Copy link
Member

@harryswift01 harryswift01 commented Feb 4, 2026

Summary

This PR improves the clarity and usability of the CodeEntropy documentation and performs light cleanup of unused command-line arguments. The changes focus on making the Getting Started workflow easier for new users, while removing deprecated or unused CLI flags and improving cross-referencing within the developer documentation.

Changes

Improve Getting Started documentation

  • Reordered examples so the smallest, fastest-running example appears first.
  • Paired each example’s config.yaml with its corresponding CLI command.
  • Added estimated runtimes to help users select appropriate examples.
  • Explicitly documented the required working directory and clarified where output files are generated.

Remove unused CLI arguments

  • Removed deprecated or unused flags from arg_config_manager.py.
  • Simplified the available argument set to better reflect current functionality.
  • Reduced potential confusion caused by obsolete options.

Improve developer documentation

  • Added references to the contributing guidelines within the developer guide.
  • Improved navigation between developer-focused documentation pages.

Impact

  • Makes the Getting Started guide easier to follow for new users.
  • Reduces setup friction and common errors related to execution context and output location.
  • Simplifies the CLI, improving maintainability.
  • Improves discoverability of contribution guidelines for developers.

@harryswift01 harryswift01 added this to the v1.1.0 milestone Feb 4, 2026
@harryswift01 harryswift01 self-assigned this Feb 4, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Feb 4, 2026
@harryswift01 harryswift01 linked an issue Feb 4, 2026 that may be closed by this pull request
@harryswift01 harryswift01 requested a review from jimboid February 5, 2026 09:19
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this. Some valuable changes to the documentation including purging old dangling features and improving the getting started docs for new users. A great PR!

@harryswift01 harryswift01 merged commit 0e01cdf into main Feb 5, 2026
27 checks passed
@harryswift01 harryswift01 deleted the 270-docs-improve-getting-started-documentation branch February 5, 2026 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Improve Getting Started Documentation Flow and Examples

2 participants