Skip to content

loopsmith v0.1.4

Choose a tag to compare

@github-actions github-actions released this 17 Aug 23:02
· 26 commits to main since this release

Documentation only. No behaviour, no API, no config-model change.

Added

  • README-FOR-DUMMIES.md — a start-to-finish guide for the people loopsmith
    is actually most useful to and who bounced off every existing page: marketers,
    salespeople, researchers, analysts. It assumes no shell fluency and no
    programming, and it stops at the point where a loop is running on a schedule.
    Everything about how the tool works internally is deliberately absent.

    It routes those readers down the Markdown path rather than the YAML one,
    and by seeding from a shipped example rather than from the blank starter —
    loopsmith new --config-file <example>.md writes loop.md and points
    run.sh at it, so the reader never has a second config file to be confused by.
    Scheduling is taught as interval seconds; cron is never mentioned, because a
    five-field expression is a wall for this reader and the trigger that avoids it
    already exists.

    It names six sections — B, C, D, F, G, H — as the whole
    editable surface, and reduces detectors to the two that need no programmer:
    file_exists and judge. It also tells the reader to delete every
    type: script check
    , which is the one edit standing between a copied example
    and a config that validates: the examples reference detector scripts the
    repository deliberately does not ship, and a non-programmer has no way to
    discover that from the error.

  • A TL;DR section at the top of README.md and of the crates.io, npm, and
    PyPI READMEs, stating the purpose in plain language and linking to the above.
    On the registry pages that link is pinned to the release tag, for the same
    reason the logo already was: a published README cannot be edited, and a
    main-relative link in one will eventually point at something else.

Changed

  • tools/sync-version.sh now also rewrites the tag-pinned README-FOR-DUMMIES.md
    link in every published README, so the release checklist stays one edit.