Standardise branding and cut the documentation back to what is true - #27
Merged
Merged
Conversation
Branding is now one string in one place. `src/data/credit.js` exports AUTHOR, LINKEDIN_URL and GITHUB_URL alongside the existing credit constants, and every surface reads from it: the app footer, the licence notice, the Markdown exports, the PNG credit badge, and — by hand, since CSS cannot import JS — the two literals in print.css. Two inconsistencies fixed rather than carried forward: - The attribution credit pointed at pedrobritx.github.io/EwP while the tool it credits lives at lessonframework.britx.me. Anyone following the credit landed somewhere else. It now points at the tool. - The author was written three ways across the repo: "pedrobritx" in the credit line, "Pedro Henrique Bahia Brito" in the copyright notice, "English with Pedro" in the footer. All three are now "Pedro Brito (BRITX)", with LinkedIn and GitHub as the standing pair. Two documents removed, ~1,270 lines: - TERMS.md restated LICENSE.md almost clause for clause. Its plain-language framing moved into LICENSE.md, which already had a summary box, and the file is gone. One authoritative licence, not two documents that can disagree. - efll-framework-v2-spec.md specified a design that was deliberately not built — a router, three authored handout tiers, a saved-lesson library — and nothing linked to it. Its level-calibration tables already live in docs/handout-authoring.md. The spec carried two citations that existed nowhere else, so deleting it would have lost them: VanPatten (1996) on input processing, which phases.js cites for a Phase 2 activity option, and Anderson (1977) on schema theory, which Phase 1 rests on. Both are now entries in references.js, where the validator can see them. 38 references to 40. The remaining prose is shorter and says the same things. README, CANON, framework-overview, handout-authoring and CONTRIBUTING lose the migration-era commentary about what moved from where — true when written, now just noise for a reader who wants to plan a lesson. Verified: validate, check-links and build all pass; the rendered footer reads "Pedro Brito (BRITX) · LinkedIn · GitHub" with the corrected URLs. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A1xddDPK8VaUvxSxvHyJPS
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
One author string, one licence document, and ~1,270 fewer lines of prose that had stopped being true.
Branding
src/data/credit.jsgainsAUTHOR,LINKEDIN_URLandGITHUB_URL, and every surface reads from it — app footer, licence notice, Markdown exports, the PNG credit badge, and by hand the two literals inprint.css, which cannot import JS.Two inconsistencies fixed rather than carried forward:
The attribution credit pointed somewhere else. It read
pedrobritx.github.io/EwPwhile the tool it credits lives atlessonframework.britx.me. Anyone following the required credit landed on a different site. It now points at the tool.The author was written three ways. "pedrobritx" in the credit line, "Pedro Henrique Bahia Brito" in the copyright notice, "English with Pedro" in the footer. All three are now Pedro Brito (BRITX), with LinkedIn and GitHub as the standing pair, closing every document.
Verified in the rendered app:
Two documents removed
TERMS.mdrestatedLICENSE.mdalmost clause for clause — two documents that could disagree about the same licence. Its plain-language framing moved intoLICENSE.md, which already had a summary box. The licence also now states the source-available/open-source distinction up front and points at the contributor sign-off.efll-framework-v2-spec.md(716 lines) specified a design that was deliberately not built: a router, three authored handout tiers, a saved-lesson library. Nothing linked to it. Its level-calibration tables already live indocs/handout-authoring.md.The spec deletion is lossless, but only after a fix
It carried two citations that existed nowhere else in the repo:
src/data/phases.js:49cites for a Phase 2 activity option, with no matching reference entryBoth are now entries in
src/data/references.js, where the validator can see them. 38 references to 40. That gap was real and predates this PR: the validator checks that every phase and activity cites something, but free-textslastrings were never checked againstreferences.js.Prose
README, CANON, framework-overview, handout-authoring and CONTRIBUTING lose the migration-era commentary about what moved from where and why. True when written; now just noise for a reader who wants to plan a lesson.
The README is restructured around what a visitor actually needs — what it is, the four steps, exports, licence, docs index, development — and drops the parallel licence restatement now that
LICENSE.mdcarries it.docs/handout-authoring.mdloses its 25-line superseded banner. The three-tier model it described was never built, so the document is now simply what it is: the level-calibration reference, plus an honest note that answer keys are a gap and why generating them per lesson beats authoring them per cell.Verification
npm run validate— passesnpm run check-links— 31 relative links resolvenpm run build— succeedsprint.cssliterals confirmed to agreeGenerated by Claude Code