Repository navigation
Docs: production mode and HF sign-in guides, Harbor up front, Spaces metadata (#1296) - #1348
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
There was a problem hiding this comment.
Alignment Review Report
Automated Checks
- Lint (bash .claude/hooks/lint.sh): PASS for files touched by this PR. The overall repo lint run fails (usort/ruff format flag ~58 pre-existing files, e.g. src/openenv/core/harness/README.md), but none of those files overlap with this PR's 18 changed files -- this PR touches only Markdown/README/YAML, no .py files, so it's unaffected by that pre-existing debt.
- Debug code (bash .claude/hooks/check-debug.sh): CLEAN for this PR. The hook flags print()/TODO occurrences, but every hit is in pre-existing src/ files (e.g. test_local_docker_provider.py, runner.py, serving.py) untouched by this diff.
- scripts/sync_env_docs.py --check: passes (only a pre-existing, non-blocking warning about envs/helium_browser_env/ lacking a README, unrelated to this PR).
Open RFCs Context
- RFC 005 (Agentic Harness Integration) -- In Review -- is referenced by the new "Harness Environments: WS /harness" section in docs/source/guides/simulation-vs-production.md. I verified the described /harness WebSocket protocol (session_started, turn_complete, session_timeout_s, error events) against src/openenv/core/env_server/http_server.py and it matches the already-implemented behavior, so this documents existing code rather than pre-empting the RFC's open discussion.
- No other open RFCs (000, 001, 002, 003, 006, 008, 010, 011, 012 -- all Draft/In Review) intersect with this change; the PR is docs/metadata only.
Tier 1: Fixes Required
None. Spot-checked claims against the implementation:
- OPENENV_MODE / create_app(..., mode="production") in simulation-vs-production.md matches src/openenv/core/env_server/http_server.py (create_app signature + ServerMode resolution).
- The new "Sign in with Hugging Face on a Space" OAuth guide (guides/customizing-web-ui.md) matches the actual envs/tau2_env/server/app.py + gradio_ui.py implementation (SYSTEM=spaces, /login/huggingface, /login/callback, /logout forwarding, gr.LoginButton()/gr.OAuthToken).
- envs/atari_env/README.md and envs/chat_env/README.md: colorFrom/colorTo changed from quoted hex codes ('#FF6200') to named HF Spaces colors (yellow/red, blue/green) -- this actually fixes an inconsistency, since every other env README in the repo (checked all 50+) uses the named-color enum, not hex.
- New HF Spaces frontmatter blocks added to chess_env, dipg_safety_env, finrl_env, git_env, kernrl, sumo_rl_env READMEs are well-formed (single --- / --- delimiter pair each) and follow the same shape as existing env READMEs.
- _toctree.yml: relocates "Harbor Spec" -> "Harbor Qualification" from the top-level Concepts section to directly under environments/harbor; both target files (guides/harbor-provider-qualification.md, environments/harbor.md) exist, and the duplicate "Harbor" card previously at the bottom of environments.md is removed in favor of the one placed near its logical neighbors -- net effect is a cleaner nav, not a duplication.
Tier 2: Alignment Discussion
Principle Conflicts
None identified. This PR doesn't touch the Gym-like/MCP boundary, reward computation, client/server imports, or any of the invariants in INVARIANTS.md -- it's purely documentation and Space metadata.
RFC Conflicts
None identified. The one RFC-adjacent addition (RFC 005 / /harness WebSocket docs) was verified against the actual implementation and is consistent with it.
Summary
- 0 mechanical issues to fix
- 0 alignment points for human review
- 0 RFC conflicts to discuss
This is a clean, well-scoped docs PR: it documents already-shipped behavior (production-mode config, harness WebSocket, HF OAuth sign-in pattern), fixes an inconsistent Space-metadata color format, backfills missing Space frontmatter for several env READMEs, and tidies up the Harbor nav entry. No blocking issues found.
Sent by Cursor Automation: Pre-review
…metadata Part of #1296. The production-mode guide covers create_app(mode=...), OPENENV_MODE and WS /harness; the web UI guide covers Hugging Face sign-in on Docker Spaces. Harbor moves to the first row of the environment grid and the qualification guide sits next to it as Harbor Qualification. Front matter for six environments, named colors for atari and chat, and links to the running openenv Spaces for echo, coding and textarena.
28fee59 to
f65bbac
Compare


Summary
Part of #1296: the items that are docs and metadata only.
Guides
guides/simulation-vs-production.md: server configuration starts withcreate_app(..., mode="production")andOPENENV_MODE, and a short section covers theWS /harnessroute that production mode adds for harness environments (RFC 005), linking the Claude Code tutorial.guides/customizing-web-ui.md: how to sign visitors in with Hugging Face on a Docker Space (hf_oauthin the README, Gradio's OAuth extras,SYSTEM=spaces, and the OAuth routes forwarded to/web), astau2_envdoes.Navigation
environments.md: Harbor moves up to the first row of the grid.Spaces metadata
base_path: /web, theopenenvtag).openenv/*Space and its URL. tbench2, sumo_rl and terminus are left out for now: their Spaces can't wake up because theopenenvorganization is over its quota, andopenenv/replis in a runtime error. They come back with the Spaces redeploy in section 5.Type of Change
Alignment Checklist
Before submitting, verify:
.claude/docs/PRINCIPLES.mdand this PR aligns with our principles.claude/docs/INVARIANTS.mdand no invariants are violated/pre-submit-pr(orbash .claude/hooks/lint.shand tests) and addressed all issuesRFC Status
Test Plan
scripts/sync_env_docs.py --checkpasses (the environment pages are regenerated from the READMEs),_toctree.ymlparses, and the three linked Space URLs answer on/health.This PR was prepared with AI assistance.
Note
Low Risk
Documentation and Space README metadata only; no application code or deployment logic changes in this PR.
Overview
Documentation and Hugging Face Spaces metadata updates: no runtime or API behavior changes in this diff.
Guides —
simulation-vs-production.mdnow documents setting mode viacreate_app(..., mode=...)andOPENENV_MODE, and adds production-modeWS /harnessfor harness environments (RFC 005).customizing-web-ui.mdadds a Sign in with Hugging Face on a Space section (hf_oauth,SYSTEM=spaces, OAuth route forwarding under/web).Navigation & discovery — Harbor is promoted on the environments grid (first row with Echo/Coding). The sidebar moves Harbor Qualification from Guides to sit next to the Harbor env page (renamed from “Harbor Spec”).
Spaces README front matter — Several envs gain standard Space YAML (
app_port,base_path: /web,openenvtag); atari and chat switch from hex to named gradient colors. Echo, coding, and textarena (Wordle) READMEs—and matching synced doc pages—add live Space URLs for try-it-now links.Reviewed by Cursor Bugbot for commit f65bbac. Bugbot is set up for automated code reviews on this repo. Configure here.