Model all learner downloads on Data Pad 2's "Download response summary"

Open
#79 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript

Research direction

Start with the // ---------- Response summary ---------- block in lilypads/data/metadata/index.qmd and compare the listed pages’ existing download buttons and learner answer controls. The issue also calls for a shared script and updates to CLAUDE.md; inspect the project’s existing script conventions before estimating the changes. Done means every listed in-scope page has a Markdown response summary matching the model, and CLAUDE.md says pages with learner answers end with one.

Written by the indexing model from the issue text.

Description

enhancement

Goal

Make every "download my answers" feature in The Pond work like the Download response summary button introduced in Data Pad 2 (Metadata for Reuse, PR #78). Learners should leave each page with a file worth keeping, not just a dump of their text boxes.

The model (Data Pad 2)

  • Label: "Download response summary". Not "reflection" or "notes".
  • File: <page>-response-summary.md (Markdown).
  • One line above the button saying what the file contains.
  • Contents, in page order:
    • a header: page title, link back to the page, date, and the page's central idea;
    • any material the learner worked on (e.g. the data file);
    • for each activity: the learner's choices and typed answers next to the reference answer, marked ✓ (matches our answer) / ✗ (doesn't) / ○ (missed);
    • the information revealed at each step;
    • every key takeaway;
    • a closing link to the next page.
  • Unanswered items show as "Not answered." Activities never revealed are still included, so the file is a complete reference.
  • Built from the page itself when the button is clicked, so edits to the .qmd text flow into the download automatically. Nothing is sent anywhere.

See the // ---------- Response summary ---------- block in lilypads/data/metadata/index.qmd.

Pages to update

  • lilypads/data/data-type/index.qmd (Data Pad 1): "Download my reflection", 2 text boxes → data-types-reflection.md. Built in OJS (Observable JavaScript).
  • lilypads/workflow/what-is-a-workflow/index.qmd: "Download my reflection" → workflow-reflection.md.
  • lilypads/workflow/methods-actionable/index.qmd: two "Download notes" buttons → correlation-reproduction-notes.txt, workflow-reproduction-notes.txt.
  • deep-water/correlation-workflow/index.qmd: "Download notes" → correlation-reproduction-notes.txt.
  • Data Pads 3–6, and any new page with learner answers: add a response summary when built (Pads 3, 4 and 5 have none yet).

Probably out of scope (different purpose)

  • lilypads/workflow/sketching-workflows/index.qmd: "Download workflow as SVG" exports the learner's drawing. It could be included in a summary, but should stay as is.
  • lilypads/workflow/sketches-vs-notebooks/index.qmd: "Download my work" / "Restore download" is a save-and-restore file and must stay machine-readable.
  • deep-water/github/start-research-repository/index.qmd: the study .zip files are course materials, not learner output.

Decided

  • Shared code: the Markdown builder goes in a shared script file that each page calls, instead of being copied into every page. Page-specific parts (what each page's activities record) stay inline. CLAUDE.md now says to share code that more than one page needs.
  • Format: Markdown everywhere. The .txt downloads become .md.

Done when

  • Every page in the list above has a "Download response summary" button that follows the model.
  • CLAUDE.md says that pages with learner answers end with a response summary.

🤖 Generated with Claude Code

Dominant language
HTML
Stars
0
Forks
0
Avg merge
5h 56m
Merged PRs (30d)
25

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from LinkedEarth/ThePond

All issues in LinkedEarth/ThePond

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.