[Docs] Pin v1.0-paper as the reproducibility tag in the README - #79
Merged
aaronsmulktis merged 2 commits intoSep 14, 2026
Merged
Conversation
`main` is about to diverge from the tree the arXiv:2511.20766 results were produced against -- PR facebookresearch#72 removes the per-app `appearance` config group in favour of a shared theme plus per-app layout, so the paper's variation overrides stop resolving. Point anyone reproducing our numbers at the `v1.0-paper` tag instead, and say plainly that everything after it is free to move.
aaronsmulktis
requested review from
marksibrahim
and
a lite review from Copilot
September 9, 2026 14:42
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new README text contains time-dependent/inaccurate statements about the current docs/config surface and includes a small typo that should be corrected.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the README to direct paper reproducibility efforts to the v1.0-paper tag, clarifying that main may diverge from the configuration surface used for arXiv:2511.20766.
Changes:
- Adds a “Reproducing the paper” section with checkout and install steps for
v1.0-paper. - Explains that post-tag changes may break old variation overrides and that results may differ slightly due to post-publication fixes.
File summaries
| File | Description |
|---|---|
| README.md | Adds reproducibility guidance pointing to v1.0-paper and describes expected divergence from main. |
Review details
Suppressed comments (2)
README.md:101
- This sentence describes the appearance→theme/layout refactor as already true on
mainand claims the docs include a migration mapping table, but the repo currently still documents and usesapps/<app>/appearance=...(e.g.,site/index.md:40-115) and there is no mapping table. This makes the README section inaccurate/time-dependent; consider switching to future tense and linking to the PR instead of asserting current docs content.
Everything after that tag is free to diverge. The first such change is the appearance refactor: the per-app `appearance` config group is replaced by a shared `apps/theme` (look) plus a per-app `apps/<app>/layout` (structure), so overrides written as `apps/todo/appearance=dark_theme` no longer resolve on `main`. See [App variations](https://facebookresearch.github.io/OpenApps/#app-variations) in the docs for the current axes, which include a table mapping every old `appearance` value onto its replacement.
README.md:103
- “map tasks” reads like a typo for the Maps app/tasks (consistent with the rest of the repo referring to the app as “maps”).
The tag is the config surface the paper used, not a byte-exact snapshot of the runs: it carries the app, task and harness fixes landed since publication, some of which move rewards (map tasks now match coordinates by ground distance, for example). Expect small differences from the published tables.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
Author
|
Whoops, accidentally closed temporarily. |
marksibrahim
approved these changes
Sep 14, 2026
marksibrahim
approved these changes
Sep 14, 2026
marksibrahim
left a comment
Contributor
There was a problem hiding this comment.
Perfect, thank you Aaron!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mainis about to diverge from the tree the arXiv:2511.20766 results were produced against -- PR #72 removes the per-appappearanceconfig group in favour of a shared theme plus per-app layout, so the paper's variation overrides stop resolving. Point anyone reproducing our numbers at thev1.0-papertag instead, and say plainly that everything after it is free to move.