Skip to content

Restructure README header and move Space config to CONTRIBUTING - #2

Merged
rajdeepchatale merged 1 commit into
mainfrom
docs/readme-layout
Sep 22, 2026
Merged

rajdeepchatale merged 1 commit into
mainfrom
docs/readme-layout

Conversation

@rajdeepchatale

Copy link
Copy Markdown
Owner

Summary

  • Removes the table at the top of the README. GitHub was rendering the Hugging Face YAML front matter as a table above the title. The config now lives in CONTRIBUTING.md under "Deploying to Hugging Face Spaces", with instructions for applying it. openenv push adds a header automatically when deploying.
  • Reorders the README. It now opens with a centered title, tagline, badges and quick links (Quickstart · Example · Tasks · Reward · Live Space), then Overview → Highlights → How it works → Example episode → Quickstart, with the reference sections after.
  • Adds an example episode taken from the environment itself. The first attempt misses a filter and gets 0.82 with a MISSING_ROWS diagnostic; the corrected query scores 0.97 and ends the episode.

Verification

  • Rendered through GitHub's Markdown API: <h1> comes first, no table precedes it, and all 16 sections appear in order.
  • openenv validate . still passes; no code changes.

🤖 Generated with Claude Code

GitHub renders the Hugging Face YAML front matter as a table above the
title. Remove it from README.md and document the Space config (and how
`openenv push` applies it) in CONTRIBUTING.md instead.

README now opens with a centered title, tagline, badges, and quick
links, followed by Overview, Highlights, How it works, a real example
episode, and Quickstart before the reference sections.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@rajdeepchatale
rajdeepchatale merged commit c452557 into main Sep 22, 2026
2 checks passed
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.

1 participant