Docs: refresh README, promote make build, fix GitHub project scope#155
Merged
dhilgaertner merged 1 commit intomainfrom Apr 10, 2026
Merged
Docs: refresh README, promote make build, fix GitHub project scope#155dhilgaertner merged 1 commit intomainfrom
dhilgaertner merged 1 commit intomainfrom
Conversation
Fixes crow#154. Promotes `make build` to the default build path in the Quick Start, corrects the GitHub auth guidance (the write `project` scope is required for IssueTracker's updateProjectV2ItemFieldValue mutation — `read:project` is insufficient), and splits long reference material into a new docs/ directory so the README can stay focused. - docs/getting-started.md: make-first build flow with all Makefile targets, correct scopes (`project,read:org,repo`), CLI permissions table for gh/glab/git/claude, all 9 mise tasks - docs/cli-reference.md: every subcommand from Packages/CrowCLI, including the previously-missing setup, close-terminal, and new-terminal --managed/--command flags - docs/architecture.md: updated package tree, Sources/CrowCLI vs Packages/CrowCLI split, markInReview data flow - docs/configuration.md: file locations verified against AppSupportDirectory.swift, 4-state TerminalReadiness tied to CrowCore/Models/Enums.swift and SessionListView rendering - docs/troubleshooting.md: INSUFFICIENT_SCOPES row pointing at IssueTracker.swift:691-692,768-769 - README.md: slimmed to overview + Quick Start + docs links - CLAUDE.md: added close-terminal and --managed flag to keep the Manager-tab CLI reference in sync with code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
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.
Closes #154
Summary
make buildto the default Quick Start path (was walking users through./scripts/build-ghostty.sh+swift buildmanually)projectscope is required (notread:project) becauseIssueTracker.markInReviewcalls theupdateProjectV2ItemFieldValuemutation — users following the old instructions hitINSUFFICIENT_SCOPESthe first time a ticket moved to In Progressdocs/directory so the README can focus on overview + getting startedNew docs
docs/getting-started.mdmake build(+ all Makefile targets), advanced/manual fallback, correct GitHub scopes, CLI permissions table (gh/glab/git/claude), all 9mise.tomltasks, first-launch wizard aligned withScaffolder.swiftdocs/cli-reference.mdPackages/CrowCLI/Sources/CrowCLILib/Commands/*.swift— including the previously-missingsetup,close-terminal, and the--managed/--commandflags onnew-terminaldocs/architecture.mdSources/CrowCLIvsPackages/CrowCLIsplit, key components with file paths,markInReviewdata flowdocs/configuration.mdAppSupportDirectory.swift, 4-stateTerminalReadinesstied toCrowCore/Models/Enums.swift:41andSessionListView.swift:325-372docs/troubleshooting.mdINSUFFICIENT_SCOPESpointing atIssueTracker.swift:691-692,768-769README changes
make buildgh auth refresh -s read:projectwithgh auth refresh -s project,read:org,reporead:projectbeing insufficientdocs/CLAUDE.md changes
close-terminalto the Terminal Commands list--managedflag tonew-terminalKeeps the Manager-tab CLI reference in sync with
Packages/CrowCLI.Acceptance criteria from crow#154
make buildas the primary build pathdocs/getting-started.md)repo,read:org,project) and exactgh auth refreshcommandread:projectis insufficientgh,glab,git,claude) documented in one placemise.tomltasks in docs match actual file (all 9 listed)Packages/CrowCLIsourceTest plan
make buildper the new Quick Start and confirm it produces.build/debug/CrowAppand.build/debug/crowgh auth refresh -s project,read:org,repoand confirmgh auth statuslistsproject(notread:project)INSUFFICIENT_SCOPESin[IssueTracker]stderrREADME.md→docs/*.mdresolves in the rendered PR viewcrow <cmd> --helpagainstdocs/cli-reference.mdfor 2-3 subcommands (e.g.add-worktree,new-terminal,set-ticket)🤖 Generated with Claude Code