Skip to content

docs(readme): move Install up and mention the import read-back of created items - #457

Merged
ryanlewis merged 2 commits into
mainfrom
docs/readme
Oct 10, 2026
Merged

ryanlewis merged 2 commits into
mainfrom
docs/readme

Conversation

@ryanlewis

Copy link
Copy Markdown
Owner

Two README changes, docs only.

  • Install moved up. ## Install now comes right after the intro (demo, feature list, agents note), before ## CLI. A reader no longer has to scroll past about 800 lines of command reference to find it. The section's text is unchanged.
  • Created-item read-back in the import section. The import section only covered the read-back of status changes. A short new "Reading back created items" subsection says that every to-do and project an import creates is read back (fix(import): read back the items an import creates #355): one line or JSON object per item, import partially applied when one never appears, search before re-running, and --no-verify skips it. It links to Logbook and import for the full rules.

Checked by reading the rendered diff. /code-review was skipped because the change is docs only.

Follow-up (not in this PR): the import section still says the CLI "forwards [the payload] verbatim", but when values are now rewritten as add sends them (today@6pm → YYYY-MM-DD@18:00). I left that wording to the --when work.

@ryanlewis
ryanlewis merged commit e1b388a into main Oct 10, 2026
8 checks passed
@ryanlewis
ryanlewis deleted the docs/readme branch October 10, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant