jwarykowski/shepherd
Watch
1
0
Fork
You've already forked shepherd
 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: a shorter README, with the reference moved into docs/ #84

Merged
jwarykowski merged 5 commits from docs/readme into master 2026-10-25 12:10:34 +00:00
Conversation 0 Commits 5 Files changed 14 +701 -628
jwarykowski commented 2026-10-25 09:34:05 +00:00
Owner
Copy link

The README drops from 659 lines to 87: the pitch, install, a short key table, a few command API examples and a docs list. The full reference moves into docs/ (keys, boards, command-api, agents, configuration, storage, stats, herdr) with every fact kept.

Also:

  • TestClassicKeys now reads the old-layout block from docs/keys.md, and the ? help points there.
  • Fixes stale keys in the moved text: the config comment said F toggles the footer (now gf), and the archive section still had c/C (now C/X).
  • GoReleaser archives ship docs/*.md so the README's links work in the tarball.
  • CLAUDE.md and CONTRIBUTING.md point at the new files.

Based on feat/keymap (#83).

The README drops from 659 lines to 87: the pitch, install, a short key table, a few command API examples and a docs list. The full reference moves into docs/ (keys, boards, command-api, agents, configuration, storage, stats, herdr) with every fact kept. Also: - TestClassicKeys now reads the old-layout block from docs/keys.md, and the ? help points there. - Fixes stale keys in the moved text: the config comment said F toggles the footer (now gf), and the archive section still had c/C (now C/X). - GoReleaser archives ship docs/*.md so the README's links work in the tarball. - CLAUDE.md and CONTRIBUTING.md point at the new files. Based on feat/keymap (#83).
docs: a shorter README, with the reference moved into docs/
All checks were successful
pull-request / lint-and-test (pull_request) Successful in 1m13s
Details
3fb3663c6a
jwarykowski changed target branch from feat/keymap to master 2026-10-25 10:16:30 +00:00
Merge remote-tracking branch 'origin/master' into docs/readme
All checks were successful
pull-request / lint-and-test (pull_request) Successful in 1m13s
Details
3b936adce0 
# Conflicts:
#	CLAUDE.md
#	README.md
#	internal/tui/keymap_test.go
#	internal/tui/view.go
jwarykowski deleted branch docs/readme 2026-10-25 12:10:34 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
jwarykowski/shepherd!84
No description provided.