Skip to content

docs(contributing): the examples repo is archived; make its page say so - #141

Merged
adnaan merged 1 commit into
mainfrom
examples-page
Aug 15, 2026
Merged

docs(contributing): the examples repo is archived; make its page say so#141
adnaan merged 1 commit into
mainfrom
examples-page

Conversation

@adnaan

@adnaan adnaan commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

/contributing/examples described how to contribute to livetemplate/examples. GitHub has that repository archived and read-only, so the workflow it documented cannot be followed.

It told the reader to create a directory there, write a go.mod pinning livetemplate v0.1.0 (core is at v0.25.0), and add a README in exactly the register #137 spent a PR removing from the ten pages that had copied it.

Two things that were not obvious

The page was never actually mirrored. It carries source_repo front matter pointing at the archived repo — but /contributing/examples has no entry in source-of-truth.yaml, and cmd/sync only walks entries from that file:

cfg, err := loadSourceOfTruth(cfgPath)
matched := filterByRepo(cfg.Pages, opts.SourceRepo)

Nothing scans front matter. So the page was already docs-native and merely mislabelled, and correcting the front matter changes no sync behaviour.

Both maps said otherwise. source-of-truth.md had it as Mirror? yes, and CLAUDE.md listed all of content/contributing/* as mirrored. Both now carve out this page and say why — otherwise the next person reads "mirrored" and skips it as unfixable, which is roughly what happened.

What the page says now

That the repo is archived, that examples live in this repo under examples/<slug>/, and where the current steps are. It repeats the two rules that have already cost real work here: include code rather than retyping it (the chat recipe documented a Change(ctx *ActionContext) API that never existed for as long as it was hand-written), and read VOICE.md before writing the prose.

619 words → 41 lines.

Verification

voice-check.sh failed on this page twice before passing, and both were mine:

  1. it quotes a banned phrase as an example of what not to write, and the check can't tell mention from use — reworded rather than exempted
  2. three passives in my own new prose — fixed rather than raising the ceiling from 34

Then: tinkerdown validate 98/98, go test ./e2e/... green uncached, and the page read back in a real browser with all six links resolving.

Adjacent, not fixed here

The archived repo is still advertised as live from mirrored pages I can't edit from this repo — contributing/livetemplate.md has git clone https://github.com/livetemplate/examples.git twice, plus references in client/index.md, reference/client-attributes.md and guides/standard-html-reactivity.md. Those need upstream PRs.

🤖 Generated with Claude Code

https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ

/contributing/examples described how to contribute to livetemplate/examples.
GitHub has that repository archived and read-only, so the workflow it documented
cannot be followed: it told the reader to create a directory there, write a
go.mod pinning livetemplate v0.1.0 (core is at v0.25.0), and add a README in the
register that #137 spent a PR removing from the ten pages that copied it.

Two things turned out to be true that were not obvious.

The page was never actually mirrored. It carries source_repo front matter
pointing at the archived repo, but /contributing/examples has no entry in
source-of-truth.yaml, and cmd/sync only walks entries from that file
(sync.go Run -> filterByRepo over cfg.Pages; nothing scans front matter). So it
was already docs-native and merely mislabelled, and correcting the front matter
changes no sync behaviour.

source-of-truth.md and CLAUDE.md both claimed otherwise. Both now say the page is
docs-native and why, so the next person does not skip it as unfixable.

The page itself now says the repo is archived, points at this repo's
CONTRIBUTING.md for the current steps, and repeats the two rules that have
already cost real work here: include code rather than retyping it, and read
VOICE.md first.

Verified: voice-check green — it failed twice on this page first, once for
quoting a banned phrase as an example of what not to write, and once for three
passives I had written, so both got fixed rather than the ceiling raised.
tinkerdown validate 98/98, e2e green, and the page read back in a real browser
with all six of its links resolving.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ
@adnaan
adnaan merged commit cb54fb3 into main Aug 15, 2026
6 of 7 checks passed
@adnaan
adnaan deleted the examples-page branch August 15, 2026 17:21
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