clarify-readme-docs-links: Clarify ZeroStarter README docs links #5
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "task/clarify-readme-docs-links"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Assigned idea
Benchmark authoring specification.
Summary: Make the top README resource links easier to scan by replacing the current icon-heavy bullets with a small Resources section that keeps the docs, llms.txt, and X links intact.
Task intent: Perform ordinary upstream README maintenance for ZeroStarter: improve discoverability of official documentation and LLM-friendly documentation links without changing the advertised architecture or tech stack.
Benchmark plan: Construct the package from commit 916eed64e157c560cffe57bdf73dd70f4292f41c. Present the solver with a README-only maintenance request: replace the three intro resource bullets with a
## Resourcessection immediately after the one-sentence project description, using specified labels and preserving the existing RC notice and architecture section. Include a Python verifier that checks exact README structure, link targets, and changed paths.Environment plan: The repo environment is only the pinned checkout of nrjdalal/zerostarter. The task environment adds Python 3 and
test_outputs.py; no Bun install, database, browser, or network access is required because the work is documentation-only.Verifier plan:
test_outputs.pyshould run from the repo root or accept the checkout path as argv. It must readREADME.md, assert the H1 and intro sentence remain, assert a## Resourcessection appears before> [!IMPORTANT], assert exact bullets for Documentation, LLM-friendly docs, and Updates with the existing URLs, assert the old emoji bullet labels are absent, assert the Architecture and Tech Stack heading plus Bun/Turborepo, Next.js 16, and Hono bullets remain, and, when.gitexists, assertgit diff --name-only HEAD --reports onlyREADME.md.Oracle plan: The oracle patch edits
README.mdonly. It replaces the three top-level bullets for documentation, AI/LLM users, and X with a## Resourcessection containing the same three upstream links in clearer prose, leaving the RC callout and architecture/tech-stack content unchanged.Difficulty plan: Low-to-moderate difficulty: current coding agents may over-edit the monorepo after seeing the tech stack, leave duplicated old bullets, move the RC notice, or alter architecture bullets. The strict placement and changed-file checks make these common deviations fail.
Repo patch scope: Expected upstream edit scope is
README.mdonly; do not edit docs site files, app/package directories, package manager metadata, generated assets, or CI files.Anti-leakage notes: Solver-facing materials must not mention benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or any evaluation context; frame it only as normal README maintenance.
Approach: Edit the opening of
README.md: keep the title and one-sentence description, add## Resources, rewrite the three existing resource links with stable labels, and ensure the existing IMPORTANT callout follows the section.Verification: Run
python3 test_outputs.py /path/to/checkout; it should pass only whenREADME.mdcontains the required Resources section and no other tracked files are changed.Risk: Primary risk is brittle wording in a documentation-only change; mitigate by providing exact desired bullet text in the solver prompt and oracle. Pinning the commit avoids drift in the README layout.
Path rules: task package is tasks/; mutable upstream checkout is tasks//task/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: clarify-readme-docs-links
Branch: task/clarify-readme-docs-links
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.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.