Skip to content

Add missing tutorials to web index#679

Open
sergiopaniego wants to merge 1 commit into
huggingface:mainfrom
sergiopaniego:fix-tutorials-index
Open

Add missing tutorials to web index#679
sergiopaniego wants to merge 1 commit into
huggingface:mainfrom
sergiopaniego:fix-tutorials-index

Conversation

@sergiopaniego
Copy link
Copy Markdown
Member

Summary

BrowserGym Harness Rollouts and Collecting rollouts for supervised training tutorials are not correctly indexed in the documentation so they're partly not visible

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation
  • New environment
  • Refactoring

Alignment Checklist

Before submitting, verify:

  • I have read .claude/docs/PRINCIPLES.md and this PR aligns with our principles
  • I have checked .claude/docs/INVARIANTS.md and no invariants are violated
  • I have run /pre-submit-pr (or bash .claude/hooks/lint.sh and tests) and addressed all issues

RFC Status

  • Not required (bug fix, docs, minor refactoring)
  • RFC exists: #___
  • RFC needed (will create before merge)

Test Plan

Claude Code Review

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label May 13, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 13, 2026

Greptile Summary

This PR fixes the docs index so that two existing tutorial pages — browsergym-harness.md and sft-warmup.md — are discoverable through the main tutorials table and Sphinx toctree.

  • browsergym-harness: was already in the toctree but missing from the rendered table; now added to both.
  • sft-warmup: was absent from both the table and the toctree; now added to both, including a Colab badge link.

Confidence Score: 5/5

Safe 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

Filename Overview
docs/source/tutorials/index.md Adds two previously-unlisted tutorials to the Markdown table and toctree; both referenced .md files exist on disk.

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]
Loading

Reviews (1): Last reviewed commit: "Add missing tutorials to web index" | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@Darktex Darktex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 the toctree entry 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 at https://colab.research.google.com/github/meta-pytorch/OpenEnv/blob/main/examples/sft_warmup.ipynb, but examples/sft_warmup.ipynb is 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

@sergiopaniego
Copy link
Copy Markdown
Member Author

Copy link
Copy Markdown
Contributor

@Darktex Darktex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-warmup toctree entry is placed consistently with the existing entries
  • The browsergym-harness table entry correctly links to browsergym-harness.md, consistent with the toctree entry already present on the base branch
  • The Colab badge URL for sft-warmup follows 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

Copy link
Copy Markdown
Contributor

@Darktex Darktex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 on main. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants