Add note about HF env hub - #614
Conversation
Greptile SummaryThis PR adds a Alignment Review ReportAutomated Checks
Tier 1: Fixes RequiredNone. Tier 2: Alignment DiscussionNone identified. Summary
Confidence Score: 5/5Safe to merge — documentation-only change with no code, API, or invariant impact. Single documentation file changed; adds a note block with an external link. No Tier 1 or Tier 2 issues identified, no invariants touched. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User visits environments.md] --> B{Note callout added by this PR}
B -->|Wants latest envs| C[HF Environment Hub huggingface.co/collections/openenv]
B -->|Wants curated docs| D[Curated env grid on this page]
C --> E[Full up-to-date catalog]
D --> F[Echo, Coding, Chat, Atari, etc.]
Reviews (1): Last reviewed commit: "Add note about HF env hub" | Re-trigger Greptile |
sergiopaniego
left a comment
There was a problem hiding this comment.
Thanks! It'd also be interesting to add https://huggingface.co/spaces?category=agent-environment, as it automatically catches envs published under any user namespace
cc @burtenshaw
changed the link to this one as I think it might be better. |
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Alignment Review Report
Automated Checks
- Lint: PASS (for this PR) - The lint failures in
docs/source/getting_started/plot_0*.pyare pre-existing and not introduced by this change. The only file this PR touches isdocs/source/environments.md, which is Markdown and not subject to Python linting. - Debug code: CLEAN - No debug code introduced.
Tier 1: Fixes Required
None.
Tier 2: Alignment Discussion
ALIGNMENT FLAG: HF Spaces category link may drift from actual hub
- Principle at stake: "Be hands-on" — Provide ready-to-use, accurate pointers, not just specs (PRINCIPLES.md §Core Principles #3)
- The concern: The note links to
https://huggingface.co/spaces?category=agent-environment. That is a generic HF Spaces category filter, not an OpenEnv-owned hub or curated collection. If the category is ever renamed, restructured, or populated with unrelated spaces, users will land somewhere confusing. The note says the hub "is kept current as new environments are added" — but there is no mechanism ensuring that; it's a third-party page OpenEnv does not control. Consider either (a) linking to an OpenEnv org page on HF (huggingface.co/openenv) that the project actually owns and maintains, or (b) softening the wording to avoid implying OpenEnv curates that page. - Suggested reviewer: @Darktex
Summary
- 0 mechanical issues to fix
- 1 alignment point for human review: the linked URL points to a third-party category page that OpenEnv does not control, while the note's wording implies the project actively maintains it
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Alignment Review Report
Automated Checks
- Lint: PASS - no issues in the changed file (pre-existing findings in unrelated source files)
- Debug code: CLEAN - no debug artifacts in the changed file
Tier 1: Fixes Required
-
/home/davidet/OpenEnv/docs/source/environments.md:3 - The HF Spaces filter URLhttps://huggingface.co/spaces?category=agent-environmentshould be verified to actually surface OpenEnv environments. Theagent-environmentcategory tag is not an official HF Spaces taxonomy category (HF uses?filter=or?sort=params, not?category=). If this URL returns no results or an error page it will confuse users. Confirm the correct filter URL before merging (e.g.https://huggingface.co/spaces?search=openenvor the actual HF org page).
Tier 2: Alignment Discussion
None identified. This is a pure documentation addition. It does not touch any code paths, does not affect API boundaries, does not expose simulation controls, and does not violate client-server separation. The intent (directing users to HF for the freshest env list) is consistent with the project's "be hands-on" and "ready-to-use implementations" principles.
Summary
- 1 mechanical issue to fix (verify the HF Spaces filter URL resolves correctly before merging)
- 0 alignment points for human review
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Alignment Review Report
Automated Checks
- Lint: PASS (for changed file) — one pre-existing
F541ruff error intests/envs/test_email_triage_env.py:161exists on the branch but is not introduced by this PR's 4-line diff. - Debug code: CLEAN — no debug artifacts in the changed file.
Tier 1: Fixes Required
None in the changed file (docs/source/environments.md).
Tier 2: Alignment Discussion
ALIGNMENT FLAG: Unverified HF Spaces filter URL
- Principle at stake: "Be hands-on" — provide accurate, working pointers to resources
- The concern: The linked URL
https://huggingface.co/spaces?category=agent-environmentuses acategory=query parameter that does not correspond to a known HF Spaces filtering scheme. HF Spaces usestask=tags (e.g.?tasks=reinforcement-learning), not acategory=agent-environmentparameter. If this URL lands on an empty or irrelevant page, the note actively misleads users rather than helping them. - Suggested reviewer: @Darktex
ALIGNMENT FLAG: Unverifiable freshness claim
- Principle at stake: "Be hands-on" — accurate docs over aspirational ones
- The concern: The note states the HF hub is "kept current as new environments are added". This is an implicit process guarantee. If there is no automation or person responsible for keeping HF up to date, this claim will age poorly and erode trust in the docs. Consider softening to "may include environments not yet listed here" rather than asserting it is definitively current.
- Suggested reviewer: @Darktex
Non-Blocking Suggestions
- The note text says "The environments highlighted below are a curated selection from the full catalog." The page already has its own introductory sentence describing itself as "a catalog". Consider trimming the note to avoid redundancy: the note sentence about the curated selection restates what the body copy already says.
- Placement is correct: the
{note}admonition at the top of the page is the right location for a caveat about catalog freshness.
Summary
- 0 mechanical issues to fix in this PR's changeset
- 2 alignment points for human review (URL accuracy, freshness claim)
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Alignment Review Report
Automated Checks
- Lint: PASS - no issues in changed file (pre-existing print/TODO findings are unrelated)
- Debug code: CLEAN - no debug artifacts in
docs/source/environments.md
Tier 1: Fixes Required
-
docs/source/environments.md:9- The link targethttps://huggingface.co/spaces?category=agent-environmentpoints to a generic HF Spaces category filter, not the OpenEnv organization. All other env links in this file usehttps://huggingface.co/spaces/openenv/.... If anopenenvorg collection or a dedicated Hub page exists, use that URL. If only the category filter is available, the link text should clarify it shows all spaces taggedagent-environmentacross HF, not just OpenEnv ones. Currently it says "OpenEnv Environment Hub on Hugging Face," which implies an OpenEnv-curated page.
Tier 2: Alignment Discussion
None identified. This is a docs-only change with no code impact, no invariant surface, and no architectural implications.
Summary
- 1 mechanical issue: link URL / link text mismatch needs resolution before merge
- 0 alignment points for human review
The note itself is a good idea — directing users to where the most current envs live is a useful pointer. The fix is small: either update the URL to the OpenEnv org page (e.g. https://huggingface.co/openenv) or adjust the anchor text to accurately describe the category-filtered search page.
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
The URL https://huggingface.co/spaces?category=agent-environment uses a query parameter (category=) that is not part of HF Spaces' public filtering scheme - HF Spaces uses tag-based search (e.g., ?p=openenv or a dedicated collection link), so this link will silently fall back to the unfiltered Spaces listing rather than an OpenEnv-specific view. Please replace it with either a verified collection/organization URL (e.g., https://huggingface.co/openenv) or remove the filter parameter until a canonical hub landing page exists.
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Alignment Review Report
Automated Checks
- Lint: PASS (for changed file) - The diff touches only
docs/source/environments.md; the one pre-existing ruff warning (F541intests/envs/test_email_triage_env.py) is not introduced by this PR. - Debug code: CLEAN - No debug code in the changed file.
Tier 1: Fixes Required
-
docs/source/environments.md:9- The linked URL (https://huggingface.co/spaces?category=agent-environment) is a generic HF Spaces category search filter, not a dedicated OpenEnv Environment Hub. The note claims it "is kept current as new environments are added," but OpenEnv has no control over the contents returned by that URL. If a dedicated hub page or collection exists (e.g.https://huggingface.co/openenv), that should be linked instead. If no such page exists yet, the claim should be weakened to "you may find additional community environments here" rather than asserting it is the canonical, always-current source.
Tier 2: Alignment Discussion
None identified. This is a pure documentation change with no code, no architectural implications, and no impact on any system invariant.
Summary
- 1 mechanical issue to fix: the linked URL and the strength of the claim about it need to be reconciled — either point to an OpenEnv-owned or verified hub URL, or soften the language so it does not promise freshness that OpenEnv cannot guarantee.
- 0 alignment points for human review.
Automated review by Claude Code | Learn more
Darktex
left a comment
There was a problem hiding this comment.
Note: This is an automated review by Claude Code, not a human review.
Summary
Docs-only PR adding a {note} callout at the top of environments.md pointing users to the "OpenEnv Environment Hub on Hugging Face" for the freshest env list. The intent is good; the execution has one concrete accuracy problem that prior automated reviews have flagged repeatedly and that a CHANGES_REQUESTED from @Darktex already covers.
Tier 1 — Bugs / Quality
docs/source/environments.md:3-6— The linked URL (https://huggingface.co/spaces?category=agent-environment) is not an OpenEnv-owned or curated page. Thecategory=query parameter is not part of HF Spaces' documented filtering scheme; all other HF links in this file use directhuggingface.co/spaces/<org>/<repo>paths. The note's claim that this hub "is kept current as new environments are added" asserts a maintenance guarantee that OpenEnv has no mechanism to enforce over a third-party category filter. Fix: either (a) link to a page OpenEnv controls (e.g.https://huggingface.co/openenv) or (b) soften the wording to "you may find additional community environments taggedagent-environmenton Hugging Face Spaces" — without implying it is an OpenEnv-curated, always-current source.
Tier 2 — Alignment
Aligned. Pure documentation addition; no code, no API surface, no invariant impact.
Verdict
Block on Tier 1: the URL accuracy and freshness-claim issue is real and unresolved, consistent with the existing CHANGES_REQUESTED from @Darktex. The fix is a one-line wording or URL change; merge after that is resolved.
Automated review by Claude Code | Learn more
|
@Darktex Made updates according to the comment. Let me know if there is any other issue. Thanks |
| The environments listed here may not reflect the latest additions. For the official OpenEnv collection, see the [OpenEnv organization on Hugging Face](https://huggingface.co/openenv). You may also find additional community environments tagged `agent-environment` on [Hugging Face Spaces](https://huggingface.co/spaces?category=agent-environment). The environments highlighted below are a curated selection. | ||
| ``` | ||
|
|
||
| The OpenEnv community has built a catalog of ready-to-run environments that cover deterministic smoke tests, full developer workflows, and multi-step reasoning challenges. Explore the surface area below and jump directly into the guides for each environment. |
The HF Space URL comes from Sergio and Ben and that is usually how I find spaces as well so I think Claude is over-concerning on this one
Summary
Adding a link to the Hugging Face Env hub so users know to check that out for the most environments
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
Example: