Skip to content

Rewrite eight descriptions chosen to break the contract #198

Description

@abernier

Part of the distilled-docs spec (parent issue). Needs the skill and the eval baseline.

Why

130 of the 170 descriptions exist with a median of 56 characters and generally name no technique; 40 are empty. "Fill the 40" probably undershoots, but that is a guess. The pilot is what turns it into an answer.

What

Run describe-example over ~8 examples, chosen to break the contract rather than flatter it:

  • 2 that already have a description — does rewriting earn its keep, or is the existing line good enough?
  • 1 whose technique is a prop rather than an import (stencil) — so apis comes out empty and the prose has to carry it alone
  • 1 with no notable drei API
  • 1 very large
  • 1 very small

Then rerun the eval and compare against the recorded baseline.

The decision this unblocks

Fill only the 40, or rewrite all 170. Do not decide it in advance.

Done when

Eight examples have a description and apis under contract, the eval has been rerun, and the issue records both the new score and the fill-40-or-rewrite-170 call with its reasoning.


How to implement

Start from a cleared session — this issue is written to be self-sufficient, and a session carrying the design discussion also carries the options that were rejected.

Branch off main once #196 and #197 have merged — it needs the skill to write with and the baseline to measure against.

git checkout -b pilot-eight
/mattpocock-skills:implement #198

implement commits to the current branch, so the branch has to exist first — otherwise this lands on main.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions