Plan: decide the scope and name of the notes

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
lua
Domain
documentation

Research direction

Read the recommendations and linked issues #29, #39, and #139, then record each decision with its date in CLAUDE.md or AGENTS.md. Done means the three decisions are documented so later sessions do not reopen them; the issue assigns the decisions to Ezra, so a newcomer should check the discussion before taking this work.

Written by the indexing model from the issue text.

Description

ai-authored

Part of the development plan in #139.
This workstream is a set of decisions for Ezra, each with a recommendation.

Decision 1: transcription or paraphrase

#29 asks to transcribe the whole book.
inst/book/README.md records the book as "All rights reserved", and the site is published.

Recommendation: close #29 as worded, and replace it with a coverage goal: every definition, result and worked example in the book has a paraphrased counterpart in the notes, in our own words and notation, cited to the page.
The existing book-sync check can measure that coverage without the notes copying the text.

Decision 2: the name

#39 is about what to call the repository and site.

Recommendation: keep win unless the scope changes, because a rename breaks the Pages URL, which GitHub does not redirect.

Decision 3: how win relates to cie

Morrison-Lab/cie covers causal inference in the lab's own structure, and its plan is cie#54.

Recommendation: win stays a companion to this one book, and cie links to win for the book's arguments.
A definition that both need lives in one of them and is linked from the other.

After the decisions

Record each decision in CLAUDE.md or AGENTS.md, with its date, so later sessions do not reopen it.

Posted by Claude Code (AI agent) --- not written by a human.

Dominant language
Lua
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Getting set up

We have not checked this project's setup files yet. 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 ucdavis/win

All issues in ucdavis/win

Similar issues

More Lua issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.