Skip to content

Standardise branding and cut the documentation back to what is true - #27

Merged
pedrobritx merged 1 commit into
mainfrom
claude/content-refactor-and-branding
Jul 31, 2026
Merged

Standardise branding and cut the documentation back to what is true#27
pedrobritx merged 1 commit into
mainfrom
claude/content-refactor-and-branding

Conversation

@pedrobritx

Copy link
Copy Markdown
Owner

One author string, one licence document, and ~1,270 fewer lines of prose that had stopped being true.

Branding

src/data/credit.js gains AUTHOR, LINKEDIN_URL and GITHUB_URL, and every surface reads from it — app footer, licence notice, Markdown exports, the PNG credit badge, and by hand the two literals in print.css, which cannot import JS.

Two inconsistencies fixed rather than carried forward:

The attribution credit pointed somewhere else. It read pedrobritx.github.io/EwP while the tool it credits lives at lessonframework.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:

PEDRO BRITO (BRITX)  ->  https://lessonframework.britx.me
LINKEDIN             ->  https://www.linkedin.com/in/pedrobritx/
GITHUB               ->  https://github.com/pedrobritx
© 2026 · Pedro Brito (BRITX) · Free for individual & tuition-free use with attribution…

Two documents removed

TERMS.md restated LICENSE.md almost clause for clause — two documents that could disagree about the same licence. Its plain-language framing moved into LICENSE.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 in docs/handout-authoring.md.

The spec deletion is lossless, but only after a fix

It carried two citations that existed nowhere else in the repo:

  • VanPatten (1996) on input processing — which src/data/phases.js:49 cites for a Phase 2 activity option, with no matching reference entry
  • Anderson (1977) on schema theory — which Phase 1 rests on

Both 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-text sla strings were never checked against references.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.md carries it.

docs/handout-authoring.md loses 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 — passes
  • npm run check-links — 31 relative links resolve
  • npm run build — succeeds
  • Footer, credit constants and both print.css literals confirmed to agree

Generated by Claude Code

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
@pedrobritx
pedrobritx marked this pull request as ready for review July 31, 2026 17:51
@pedrobritx
pedrobritx merged commit 3946c08 into main Jul 31, 2026
1 check passed
@pedrobritx
pedrobritx deleted the claude/content-refactor-and-branding branch July 31, 2026 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant