Repository navigation
Conversation
Work in progress on the newcomer-docs spec (.freethinking/specs/newcomer-docs/), committed locally so it is not lost; the plan-a-year and tune-a-template guides, their captures and the integrity check are still to come. - README.md rewritten as the newcomer front door; contributor material moved to .github/CONTRIBUTING.md - plugins/freethinking/README.md cut to a self-contained listing page; detail moved to docs/reference.md - docs/guides/: build-a-feature, fix-a-bug, make-a-small-change - docs/evidence.md with the with-without rule eval runs of 2026-10-22 - docs/captures/render.py renders real session transcripts as terminal SVGs, with tests in checks/test_capture_render.py and 14 captures - llms.txt; manifest descriptions set to the pitch; version 0.17.0 - evals/skills/bugfix/reads-back-without-ticket and a corrected passage in evals/README.md on how Skill graders are scored Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why
The repository and its plugin were documented for the people who build them, not for someone arriving to decide whether to use it. In the author's words when this work started: "look at https://github.com/freethinkingit/inline-email notice the readme, the guides, the style... we have some work to do". The work follows the spec in
.freethinking/specs/newcomer-docs/.What
A newcomer landing on the repository now gets the author's pitch, the install, a real session image, a "when to use it" comparison with plain Claude Code and Kiro, and links to task-shaped guides, a reference page and an evidence page. The plugin README becomes a short page that stands on its own in the plugin listing, and the version rises to 0.17.0 so installed copies receive it.
Changes
README.mdrewritten: pitch, Docs line, install, hero capture, what it does with a hand-off diagram, when to use it, how it is tested, what it does not do, develop the plugin, license. The old layout list, "Add or change a skill or rule" and "Testing" moved into.github/CONTRIBUTING.md. Why: the author's request quoted above.plugins/freethinking/README.mdcut to the pitch, install, one line per skill, agent and rule, "What the plugin runs and sends" and absolute links;llms.txtadded at the root; both manifest descriptions set to the pitch's first sentence;plugin.jsonat 0.17.0. Reason not provided by the author.docs/reference.mdholds the per-skill, per-agent, per-rule and per-hook detail that left the listing page, with a table of contents. Reason not provided by the author.docs/guides/build-a-feature.md,fix-a-bug.mdandmake-a-small-change.md, each built from real session captures, with sequence diagrams for the multi-agent jobs. Reason not provided by the author.docs/evidence.mdshows the four rule targets run with and without the plugin on 2026-10-22, says which comparisons are fair, and lists what is not measured;evals/README.md's passage on how Skill graders are scored under--ablation with-withoutcorrected to match the run data. Why, in the author's words: "we can use our evals right? with deltas?"docs/captures/render.py(standard library) extracts a range of a Claude Code transcript and renders it as a terminal SVG;checks/test_capture_render.pytests determinism and that the text survives; 14 capture sources underdocs/captures/, with their generated SVGs underdocs/images/. Reason not provided by the author.evals/skills/bugfix/reads-back-without-ticket/checks thatbugfixstates Symptom, Expected and Context back before running anything, from a session where it did not. Why, in the author's words: "add an eval case"..freethinking/specs/newcomer-docs/requirements, design and tasks. Reason not provided by the author.Testing
Recorded in the session that built this branch; the author has not yet walked the changes.
make validate: 31 tests OK, and all threeclaude plugin validate --strictruns passed.--ablation with-without, 2026-10-22, plugin 0.17.0 from this branch: tables indocs/evidence.md. Mean Δ: collaboration +0.44, code-changes +0.27, workflow +0.48 (mostly skill existence, as the page explains), communication 0.00.make eval-skill-bugfix EVAL_ARGS="--case reads-back-without-ticket --keep-temp", 2026-10-22:The kept traces held no copy of the skill's text, so the graders matched Claude's own read-back.
Risk and rollout
docs/guides/plan-a-year.md,docs/guides/tune-a-template.md) are not written yet, so their links from the README, the listing page andllms.txtdo not resolve. They wait on two sessions the author runs.plugin.json's description ship with the plugin at 0.17.0; the listing page links absoluteblob/mainURLs, which resolve only after merge.Notes for reviewers
prwalkthrough before marking it ready; the bullets marked "Reason not provided by the author" get the author's reasons then.checks/test_docs.py) and its tests, and the GitHub description and topics, set on the author's yes.