snorkel/root-repository-maintenance-211720333dcd47
2
0
Fork 0
Code Issues Pull requests 5 Projects Releases Packages Wiki Activity

docs-mdx-type-checking: Enable Docs MDX Type Checking #2

Open
std-bot wants to merge 1 commit from task/docs-mdx-type-checking into main
pull from: task/docs-mdx-type-checking
merge into: snorkel:main
Conversation 0 Commits 1 Files changed 29 +139 -180
std-bot commented 2026-06-07 21:50:50 +00:00
First-time contributor
Copy link

Assigned idea

Benchmark authoring specification.

Summary: Update the docs TypeScript configuration so MDX documents are included in the docs project while preserving the existing Vite and MDX ambient type configuration.

Task intent: For the upstream docs site, make MDX files first-class inputs to the TypeScript project. The current docs config already declares MDX types, but its include list only covers TypeScript and TSX files, so the ordinary maintenance work is to include MDX documents without weakening the existing strict compiler settings.

Benchmark plan: Construct a regular repository-backed package that asks the solver to update the docs TypeScript project configuration. The solver-facing prompt should focus only on the upstream docs behavior: MDX files should be part of the docs TypeScript project, and the existing vite/client and mdx type entries must remain. The expected change is small and deterministic, centered on docs/tsconfig.json.

Environment plan: Use the materialized repository at commit 2c1b8c1b0fa27220aafa3a5863e5da7fe2721e80 as the environment/repo. The task/environment should add only the prompt and verifier files outside the upstream patch scope. No network access or dependency installation is required for the primary verifier because docs/tsconfig.json can be parsed directly as JSON.

Verifier plan: test_outputs.py should parse docs/tsconfig.json and assert that compilerOptions.types still contains both vite/client and mdx, compilerOptions.strict remains true, noEmit remains true, and include contains **/.ts, **/.tsx, and **/*.mdx. It should also reject overly broad replacements such as */ that would hide the intended MDX-specific fix.

Oracle plan: The oracle solution edits docs/tsconfig.json so the include array becomes equivalent to ["/*.ts", "/.tsx", "**/.mdx"] while leaving the existing compilerOptions, especially types: ["vite/client", "mdx"], intact.

Difficulty plan: Current coding agents may focus on installing MDX packages or changing compilerOptions.types instead of noticing the mismatch between the declared MDX types and the include globs. They may also use a broad include pattern, remove strict settings to make checks pass, or alter unrelated docs configuration files.

Repo patch scope: Expected upstream edit scope is docs/tsconfig.json only. Do not modify package manifests, source directories, generated docs content, or dependency lockfiles.

Anti-leakage notes: The solver-facing materials must not mention benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or evaluation context. Present the work as a normal upstream docs TypeScript configuration fix.

Approach: Change the docs tsconfig include list to explicitly add MDX files while preserving the existing TypeScript, TSX, Vite, MDX, strictness, and no-emit settings.

Verification: Run python test_outputs.py. The verifier should inspect docs/tsconfig.json and confirm the exact required compiler option preservation plus the MDX-specific include glob.

Risk: Low. The task is intentionally narrow and structural; the main risk is an overbroad include glob or unrelated config churn, which the verifier should reject.

Path rules: task package is tasks/; mutable upstream checkout is tasks//environment/repo; benchmark package files are under tasks//task; verifier/container environment belongs under tasks//task/environment; regular and UI verifier logic belongs in task/tests/test_outputs.py and test.sh only runs that file through pytest.

Agent context

Task slug: docs-mdx-type-checking
Branch: task/docs-mdx-type-checking

## Assigned idea Benchmark authoring specification. Summary: Update the docs TypeScript configuration so MDX documents are included in the docs project while preserving the existing Vite and MDX ambient type configuration. Task intent: For the upstream docs site, make MDX files first-class inputs to the TypeScript project. The current docs config already declares MDX types, but its include list only covers TypeScript and TSX files, so the ordinary maintenance work is to include MDX documents without weakening the existing strict compiler settings. Benchmark plan: Construct a regular repository-backed package that asks the solver to update the docs TypeScript project configuration. The solver-facing prompt should focus only on the upstream docs behavior: MDX files should be part of the docs TypeScript project, and the existing vite/client and mdx type entries must remain. The expected change is small and deterministic, centered on docs/tsconfig.json. Environment plan: Use the materialized repository at commit 2c1b8c1b0fa27220aafa3a5863e5da7fe2721e80 as the environment/repo. The task/environment should add only the prompt and verifier files outside the upstream patch scope. No network access or dependency installation is required for the primary verifier because docs/tsconfig.json can be parsed directly as JSON. Verifier plan: test_outputs.py should parse docs/tsconfig.json and assert that compilerOptions.types still contains both vite/client and mdx, compilerOptions.strict remains true, noEmit remains true, and include contains **/*.ts, **/*.tsx, and **/*.mdx. It should also reject overly broad replacements such as **/* that would hide the intended MDX-specific fix. Oracle plan: The oracle solution edits docs/tsconfig.json so the include array becomes equivalent to ["**/*.ts", "**/*.tsx", "**/*.mdx"] while leaving the existing compilerOptions, especially types: ["vite/client", "mdx"], intact. Difficulty plan: Current coding agents may focus on installing MDX packages or changing compilerOptions.types instead of noticing the mismatch between the declared MDX types and the include globs. They may also use a broad include pattern, remove strict settings to make checks pass, or alter unrelated docs configuration files. Repo patch scope: Expected upstream edit scope is docs/tsconfig.json only. Do not modify package manifests, source directories, generated docs content, or dependency lockfiles. Anti-leakage notes: The solver-facing materials must not mention benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or evaluation context. Present the work as a normal upstream docs TypeScript configuration fix. Approach: Change the docs tsconfig include list to explicitly add MDX files while preserving the existing TypeScript, TSX, Vite, MDX, strictness, and no-emit settings. Verification: Run python test_outputs.py. The verifier should inspect docs/tsconfig.json and confirm the exact required compiler option preservation plus the MDX-specific include glob. Risk: Low. The task is intentionally narrow and structural; the main risk is an overbroad include glob or unrelated config churn, which the verifier should reject. Path rules: task package is tasks/<slug>; mutable upstream checkout is tasks/<slug>/environment/repo; benchmark package files are under tasks/<slug>/task; verifier/container environment belongs under tasks/<slug>/task/environment; regular and UI verifier logic belongs in task/tests/test_outputs.py and test.sh only runs that file through pytest. ## Agent context Task slug: docs-mdx-type-checking Branch: task/docs-mdx-type-checking <!-- std-ts:idea-pr-body -->
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin task/docs-mdx-type-checking:task/docs-mdx-type-checking
git switch task/docs-mdx-type-checking

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch main
git merge --no-ff task/docs-mdx-type-checking
git switch task/docs-mdx-type-checking
git rebase main
git switch main
git merge --ff-only task/docs-mdx-type-checking
git switch task/docs-mdx-type-checking
git rebase main
git switch main
git merge --no-ff task/docs-mdx-type-checking
git switch main
git merge --squash task/docs-mdx-type-checking
git switch main
git merge --ff-only task/docs-mdx-type-checking
git switch main
git merge task/docs-mdx-type-checking
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
snorkel/root-repository-maintenance-211720333dcd47!2
No description provided.