docs: fix Setup/credentials ordering, stale free-session detail claims, and a broken filename ref#26
Open
stozo04 wants to merge 3 commits into
Open
docs: fix Setup/credentials ordering, stale free-session detail claims, and a broken filename ref#26stozo04 wants to merge 3 commits into
stozo04 wants to merge 3 commits into
Conversation
A first-time reader following the SKILL.md top-to-bottom hit `speediance-cli login` (in Setup) before the Credentials section told them to set SPEEDIANCE_EMAIL/PASSWORD. But `login` calls RequireCredentials() and exits with a config error when email/password are unresolved — so the documented first command fails. Restructure "Setup (one time)" into an explicit ordered sequence: 1. Install 2. Provide credentials (env / .env / `config set`) 3. login 4. first data command Also surface the `config set` path (writes config.json at 0600) with a shell-history caveat, and add an explicit workspace `.env` note for OpenClaw / headless agent use. Docs only; no code change.
…detail claims Companion to the SKILL.md Setup reorder on this branch. README (Install): the Go-install snippet ran `speediance-cli login` before the credentials paragraph, so a copy-paste first run hit a config error (login calls RequireCredentials before any network call). Reorder to install -> set credentials -> login, surface `config set`, and add an explicit credentials-first note. Accuracy fix in both files: the overhaul made the CLI a verbatim passthrough that now emits guided free-session detail (e.g. Aerobic Rowing). Two stale lines still implied all free sessions are totals-only: - SKILL.md "Empty shape" bullet said detail is `[]` for kind:"free" (contradicting its own table/notes). Corrected: `[]` for a freestyle Free Lift, populated for a guided free session. - README Notes said Free Lift sessions return totals only / "Programs do." Corrected to include guided free sessions returning full detail. Docs only; no code change.
stozo04
changed the title
CLAUDE.md referenced `Releasing.md`, but the file is `RELEASING.md` (uppercase, matching GOAL.md / AGENTS.md). On GitHub and any case-sensitive filesystem the lowercase form resolves to nothing, so a contributor or agent pointed at it hits "no such file." Docs only.
stozo04
changed the title
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.
Docs-only PR. No code changes. Three doc files corrected.
1. Setup / credentials ordering (SKILL.md + README)
Both docs told a new user to run
speediance-cli loginbefore telling them to set credentials. Butloginresolves credentials up front —newLoginCmd→apiClient(false)→resolveConfig()→RequireCredentials(), which returns a config error (ExitConfig) the instant email or password is empty, before any network call. So the documented first command failed.login→ first data command. Surfaced theconfig setpath (writesconfig.jsonat0600) with a shell-history caveat, and added an explicit workspace-.envnote for OpenClaw / headless agents.loginprematurely; credentials now come first, with the sameconfig setoption and a credentials-first note.2. Accuracy: free-session detail (SKILL.md + README)
The overhaul made the CLI a verbatim passthrough that now emits guided free-session detail (e.g. Aerobic Rowing) — not just program detail. Two stale lines still implied all free sessions are totals-only:
detailis[]forkind:"free"— contradicting its own table and notes. Corrected:[]for a freestyle Free Lift, populated for a guided free session.3. Broken filename reference (CLAUDE.md)
CLAUDE.mdpointed to`Releasing.md`, but the file isRELEASING.md(uppercase, matchingGOAL.md/AGENTS.md). On GitHub / any case-sensitive filesystem the lowercase form resolves to nothing. Corrected the casing.Verification
Read the output-producing code (
workout/model.go,api/endpoints.go, the command bodies,template,exit.go,output.go) to confirm the documented output shapes —{training_id, kind, info, detail}, theworkoutsdigest fields,library[{id,name,muscle,tab}], the plan schema, exit codes — all match. For CLAUDE.md, confirmed every concrete reference resolves: both.claude/imports exist, the named immutable guard test exists ininternal/cli, and.github/workflows/ci.ymldoes rungo test -race+ lint onpull_request. After each push, re-fetched the files from the branch and diffed against the verified local copies (byte-identical md5).