docs: document system-level backlog and out-of-git operation#21
Merged
Conversation
Update README and the workflows guide to reflect the system backlog added in #19. The "per-repo, not global" framing and the "not a global config" claim were factually wrong after that change; the resolution tables and mechanism list omitted --system and the out-of-git fallback, and described --file as git-root-relative without the outside-repo case.
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
2 participants
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.
Summary
Follow-up to #19 (System-Level Backlog & Out-of-Git Operation), which shipped the feature and updated
docs/specs/overview.md+docs/memory/, but left the human-facing top-level docs stale. These pages also feed the published docs site (shll.ai pulls README +docs/site/**), so the inaccuracies were user-visible.What was wrong
README.md"Per-repo, not global" andworkflows.md"not on... a global config" — both now factually incorrect: the system backlog is a global option.--systemand the automatic out-of-git fallback row.--filewas described as "relative to the git root" with no mention of the outside-repo rooting (~/.config/idea) or absolute-path-verbatim behavior.Changes
README.md— rewrote the "per-repo" bullet, added--systemto the worktree bullet, and added system-backlog + out-of-git rows to the resolution table (with XDG / mutual-exclusion notes).docs/site/workflows.md— fixed the intro, the resolution table, and the under-the-hood mechanism list (now ordered first-match-wins:--system→--file/IDEAS_FILE→--main→ in-repo default → system fallback), plus a note in the rationale paragraph.Docs-only; no code changes.