docs(contributing): the examples repo is archived; make its page say so - #141
Merged
Conversation
/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
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.
/contributing/examplesdescribed how to contribute tolivetemplate/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.modpinninglivetemplate 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_repofront matter pointing at the archived repo — but/contributing/exampleshas no entry insource-of-truth.yaml, andcmd/synconly walks entries from that file: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.mdhad it asMirror? yes, andCLAUDE.mdlisted all ofcontent/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 aChange(ctx *ActionContext)API that never existed for as long as it was hand-written), and readVOICE.mdbefore writing the prose.619 words → 41 lines.
Verification
voice-check.shfailed on this page twice before passing, and both were mine:Then:
tinkerdown validate98/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.mdhasgit clone https://github.com/livetemplate/examples.gittwice, plus references inclient/index.md,reference/client-attributes.mdandguides/standard-html-reactivity.md. Those need upstream PRs.🤖 Generated with Claude Code
https://claude.ai/code/session_0166MK1arBYbVZq6wfm8EsQZ