offline-html-export-docs: Clarify offline HTML export behavior #5
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "task/offline-html-export-docs"
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: Add a focused README section that makes cad-viewer's one-click self-contained HTML export capability easier to discover and verifies the documented offline viewer guarantees.
Task intent: Perform ordinary upstream documentation work for cad-viewer by expanding README.md with a dedicated section explaining the single-file HTML export, including offline use, no backend/server/install requirements, and retained viewer interactions such as pan, zoom, layer toggling, and distance measurement.
Benchmark plan: Construct the work package as a docs-only repository change at commit 1891d55fef149b19080d439447aa8b3b8710945e. The solver-facing request should ask for a new dedicated README.md section placed after the introductory export paragraph and before the external links, with deterministic content requirements: mention one-click export, a single self-contained .html artifact, no CAD app, no server, no install, offline/open-in-browser usage, pan/zoom, layer toggling, distance measurement, and practical sharing/archive/air-gapped use cases. Do not require dependency installation or application runtime changes.
Environment plan: Task environment: provide the repository checkout and a Python 3 verifier using only the standard library. No network access, browser automation, npm install, or build step is needed because the intended change is README.md-only. Environment/repo distinction: the upstream repo remains the cad-viewer source tree at the fixed commit, while the task environment only adds verifier files outside the solution patch.
Verifier plan: Create test_outputs.py that reads README.md and asserts: a heading matching Self-contained HTML export exists before the Live Demo link block; the section contains case-insensitive references to one-click export, single/self-contained HTML, no CAD app, no server, no install, offline or browser opening, pan, zoom, layer toggling, distance measurement, client sharing, compliance archive, and air-gapped workflows; README.md still contains the original CAD-Viewer heading and Live Demo link; and no files other than README.md are modified in the submitted patch.
Oracle plan: Provide an oracle solution patch that edits only README.md by inserting a concise 'Self-contained HTML export' section immediately after the existing introductory paragraph about portable offline artifacts. The oracle text should satisfy every verifier phrase requirement without changing links, project positioning, or repository code.
Difficulty plan: Automated coding systems may overreach into implementation files, omit one of the exact offline guarantees, place the new section where the verifier cannot identify it, or paraphrase away required capabilities such as layer toggling and distance measurement. The deterministic placement and phrase coverage make the task simple for maintainers but easy to miss if treated as a generic README rewrite.
Repo patch scope: Expected upstream edits are limited to README.md only.
Anti-leakage notes: Solver-facing materials must not mention benchmark, harness, Snorkel, Harbor, std-ts, agent, stage, attempt, retry, generated task, or evaluation context. Present the work only as a normal upstream README improvement.
Approach: Insert a short, discoverable README.md section that turns the existing marketing paragraph into concrete user-facing documentation for exporting and sharing a self-contained offline HTML viewer artifact.
Verification: Run python -m pytest test_outputs.py, or directly run python test_outputs.py if implemented without pytest; the verifier must inspect README.md content and the changed-file list.
Risk: Low risk because the intended change is documentation-only. Main risk is over-constraining prose; keep verifier checks focused on required concepts and placement rather than exact full paragraph text.
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: offline-html-export-docs
Branch: task/offline-html-export-docs
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.