docs: discoverable doc headers for every flat tool in LIFEOS/TOOLS#1607
Open
anikinsasha wants to merge 1 commit into
Open
docs: discoverable doc headers for every flat tool in LIFEOS/TOOLS#1607anikinsasha wants to merge 1 commit into
anikinsasha wants to merge 1 commit into
Conversation
Comment-only. Brings every flat tool in the shipped root up to one header contract: an identity line (<Name>.ts — one-line purpose), purpose prose, runnable usage for invocable tools (library modules state their importers instead), and an @see pointer only where a governing doc exists. Banner theme variants honestly labeled as unwired prototypes. Fixes GetTranscript.ts usage examples pointing at a nonexistent skill path and two other dangling skill references (AddBg, ExtractTranscript). A short standard doc codifying this contract may follow as a separate contribution.
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
1 participant
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.
Summary
Every flat (single-file) tool in
LIFEOS/TOOLS/now carries a doc header that says what it is, how to run it, and where its governing doc lives. Comment-only — zero code changes.Agents and humans alike decide what a tool does by reading its head. Most tools here already follow a strong de-facto convention (see
Inference.ts,WorkSweep.ts,ISARender.ts); this PR brings the stragglers up to the same bar: on a census of the shipped root, ~25 tools were missing an identity line and/or usage, and several were completely headerless (ForgeProgress.ts,HealthSnapshot.ts,SplitAndTranscribe.ts).The header contract (codified from the corpus, not invented)
A flat tool's leading comment block carries:
<Name>.ts — <one-line purpose>Consumed by:line; dual modules carry both@seepointer — only where a governing doc actually exists (skill, system doc, subsystem README)That's the whole contract, stated here in full — this PR intentionally cites no standard file, since none ships in the repo today. A short standard doc codifying the contract may follow as a separate contribution.
What's in the diff
PiSync.sh), each derived from the file's actual code — argv handling read before writing usage lines.BannerMatrix,BannerNeofetch,BannerPrototypes,BannerRetro,BannerTokyo,NeofetchBanner) are honestly labeled as alternative prototypes not wired to the launcher (onlyBanner.tsis invoked).GetTranscript.ts's usage examples pointed at askills/Videotranscript/location that does not exist in the repo; corrected to the tool's real path.Verification