Skip to content

docs: Move rich logging documentation to README.md#430

Merged
simonrosenberg merged 2 commits into
mainfrom
move-logging-docs-to-readme
Feb 19, 2026
Merged

docs: Move rich logging documentation to README.md#430
simonrosenberg merged 2 commits into
mainfrom
move-logging-docs-to-readme

Conversation

@juanmichelini

Copy link
Copy Markdown
Collaborator

Summary

Moves the rich logging documentation from a separate benchmarks/utils/logging.md file into the main README.md as a new section.

Motivation

Addresses review feedback from @simonrosenberg on PR #413, who asked:

Does this require its own md file? Or should it be a section of the README.md?

Consolidating the documentation in the README makes it:

  • More discoverable for users
  • Easier to maintain (single source of truth)
  • Consistent with how other feature documentation is organized in the project

Changes

  • ✅ Added "Rich Logging" section to README.md after "Running Benchmarks"
  • ✅ Removed benchmarks/utils/logging.md
  • ✅ No changes to functionality, only documentation organization

Related

Move logging documentation from separate benchmarks/utils/logging.md file
into the main README.md as a new section. This makes the documentation
more discoverable and consolidates all user-facing docs in one place.

Addresses review feedback from @simonrosenberg on PR #413.

Co-authored-by: openhands <openhands@all-hands.dev>
@simonrosenberg simonrosenberg self-requested a review February 19, 2026 14:51
@simonrosenberg

Copy link
Copy Markdown
Member

@OpenHands read the PR diff. The new section in the README.md is very long. Make it shorter, only share the essential info

@openhands-ai

openhands-ai Bot commented Feb 19, 2026

Copy link
Copy Markdown

I'm on it! simonrosenberg can track my progress at all-hands.dev

Co-authored-by: openhands <openhands@all-hands.dev>
@openhands-ai

openhands-ai Bot commented Feb 19, 2026

Copy link
Copy Markdown

Summary

I addressed the PR review feedback requesting to shorten the Rich Logging section in README.md.

Checklist

Read the PR diff - Reviewed the full Rich Logging section that was added (lines 120-221, ~100 lines)
Made it shorter - Condensed from ~100 lines to ~18 lines
Kept only essential info - Retained:

  • How to enable (RICH_LOGGING=1)
  • How to disable colors (NO_COLOR=1)
  • Brief example of output format
  • Note that file logging is unaffected
    Removed non-essential details:
  • Detailed explanations of 5 different log types
  • Full summary fields table (9 rows)
  • Color coding explanation
  • Verbose file logging section
    Changes are concise - Only modified the Rich Logging section, no extraneous changes
    Pushed to remote - Commit d2d8a27 pushed to move-logging-docs-to-readme branch

Result

The Rich Logging section now provides a quick reference for users to enable the feature and understand the output format, without overwhelming documentation that could live elsewhere if detailed reference is needed later.

@simonrosenberg simonrosenberg merged commit 22ece73 into main Feb 19, 2026
2 checks passed
@simonrosenberg simonrosenberg deleted the move-logging-docs-to-readme branch February 19, 2026 15:00
KTanmay1 pushed a commit to Ethara-Ai/milo-bench that referenced this pull request Mar 3, 2026
* docs: Move rich logging documentation to README.md

Move logging documentation from separate benchmarks/utils/logging.md file
into the main README.md as a new section. This makes the documentation
more discoverable and consolidates all user-facing docs in one place.

Addresses review feedback from @simonrosenberg on PR OpenHands#413.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: Condense Rich Logging section to essential info

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
KTanmay1 pushed a commit to Ethara-Ai/milo-bench that referenced this pull request Mar 3, 2026
* docs: Move rich logging documentation to README.md

Move logging documentation from separate benchmarks/utils/logging.md file
into the main README.md as a new section. This makes the documentation
more discoverable and consolidates all user-facing docs in one place.

Addresses review feedback from @simonrosenberg on PR OpenHands#413.

Co-authored-by: openhands <openhands@all-hands.dev>

* docs: Condense Rich Logging section to essential info

Co-authored-by: openhands <openhands@all-hands.dev>

---------

Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants