Add missing tutorials to web index#679
Conversation
Greptile SummaryThis PR fixes the docs index so that two existing tutorial pages —
Confidence Score: 5/5Safe to merge — documentation-only change with no code execution paths affected. Both tutorial files referenced by the new table rows (browsergym-harness.md and sft-warmup.md) already exist on disk. The toctree entry for browsergym-harness was already present before this PR, and the new sft-warmup entry is correctly placed. The Colab badge URL follows the same pattern used by other entries in the file. Nothing here can break a build or introduce incorrect behavior. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[docs/source/tutorials/index.md] --> B[Markdown Table]
A --> C[toctree hidden block]
B --> D[browsergym-harness.md added to table]
B --> E[sft-warmup.md added to table]
C --> F[browsergym-harness was already present]
C --> G[sft-warmup added to toctree]
Reviews (1): Last reviewed commit: "Add missing tutorials to web index" | Re-trigger Greptile |
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 — Tier 1/Tier 2
Automated Checks
- Lint: PASS — docs-only change, no Python files modified
- Debug code: N/A — markdown only
Tier 1: Fixes Required
The PR adds two entries to the tutorial index and toctree, but the referenced source files are missing from the repo. Sphinx will fail to build:
-
docs/source/tutorials/sft-warmup.md— does not exist; both the table row and thetoctreeentry reference it. Sphinx will error on the missing toctree target. -
docs/source/tutorials/browsergym-harness.md— does not exist either (pre-existing breakage that this PR makes more visible by also putting the entry in the table, not just the toctree). -
examples/sft_warmup.ipynb— the Colab badge points athttps://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/sft_warmup.ipynb, butexamples/sft_warmup.ipynbis not in the repo. Users clicking the badge will hit a 404.
Tier 2: Alignment Discussion
None identified — this is a docs index change with no architectural implications.
Summary
The intent is good (surface tutorials that already exist), but as-written the build will fail and the Colab link is dead. The tutorial markdown files (and the sft_warmup.ipynb notebook) need to land alongside these index entries — either in this PR or as predecessor PRs that this one rebases onto.
Verdict: request_changes
Automated review by Claude Code | Learn more
|
Answering @Darktex comments:
|
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 — Tier 1/Tier 2
Automated Checks
- Lint: PASS — docs-only change, no Python files modified
- Debug code: N/A — markdown only
Tier 1: Fixes Required
None identified. The diff is syntactically correct markdown/MyST:
- Both new table rows follow the exact column format (pipe-delimited, 4 columns: title+link, description, GPU flag, Colab badge)
- The
sft-warmuptoctree entry is placed consistently with the existing entries - The
browsergym-harnesstable entry correctly links tobrowsergym-harness.md, consistent with the toctree entry already present on the base branch - The Colab badge URL for
sft-warmupfollows the same pattern as other entries
Regarding the prior automated review: The CHANGES_REQUESTED review (submitted via the Darktex account on May 13) was incorrect. It claimed sft-warmup.md, browsergym-harness.md, and examples/sft_warmup.ipynb do not exist. All three files have been confirmed to exist on the main branch via the GitHub API. The prior review checked against a local checkout on a different branch and should be dismissed.
Tier 2: Alignment Discussion
None identified. This is a pure documentation index update with no architectural implications.
Summary
- 0 mechanical issues
- 0 alignment concerns
- Prior CHANGES_REQUESTED review was based on incorrect file existence checks and should be dismissed
Verdict: APPROVE
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: PR #679
Tier 1: Verification needed
Referenced tutorial files may be missing:
This PR adds table entries for browsergym-harness.md and sft-warmup.md, and adds sft-warmup to the toctree. Please verify both files exist (or will exist at merge time):
docs/source/tutorials/browsergym-harness.md— was already in the toctree before this PR, so it should exist onmain. If not, the toctree was already broken.docs/source/tutorials/sft-warmup.md— newly added to toctree. If this file doesn't exist yet, the Sphinx build will fail with a missing document error.
A toctree entry pointing to a non-existent document is a hard Sphinx build error.
Tier 2: Alignment
No concerns. Pure documentation change with no impact on system invariants. Table formatting matches existing entries.
Automated review by Claude Code | Learn more
Summary
BrowserGym Harness RolloutsandCollecting rollouts for supervised trainingtutorials are not correctly indexed in the documentation so they're partly not visibleType 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
Claude Code Review