Document hierarchical team-prefix grouping and add CHANGELOG entry - #191
Open
shouze wants to merge 1 commit into
Open
Document hierarchical team-prefix grouping and add CHANGELOG entry#191shouze wants to merge 1 commit into
shouze wants to merge 1 commit into
Conversation
|
Coverage after merging feat/team-hierarchy-docs into feat/team-hierarchy-cli will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
🔦 Lighthouse Report
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documents hierarchical team-prefix grouping and adds a pending v2.0.0 changelog entry without cutting the release.
Changes:
- Rewrites team-grouping usage documentation with syntax, nesting, consolidation, JSON, TUI, and team-picking examples.
- Updates grouping-related CLI option references.
- Adds a pending changelog entry linked to EPIC #125.
- Nit: the nested example’s summary does not match the displayed rows.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/usage/team-grouping.md |
Documents hierarchical grouping behavior and workflows. |
docs/reference/cli-options.md |
Updates grouping-related CLI options. |
CHANGELOG.md |
Adds the pending v2.0.0 entry. |
Suppressed comments (6)
docs/usage/team-grouping.md:193
- This code fence is newly added without a language tag, but the documentation guidelines require every fenced block to declare one. Add
text(or another appropriate language) after the opening fence so the page remains consistent and the docs formatting check does not flag it.
**docs/usage/team-grouping.md:48**
* At the top level, repos that do not match the current chain are not immediately put into an `other` section: they remain in the pool for later independent chains, and `groupByTeamHierarchy` adds one final top-level `other` only after all chains have run (`src/group.ts:112-128`). Please scope this step to nested levels or describe the final residual pool exception.
- Repos matching no team at this level → collected into an
othersection.
**docs/usage/team-grouping.md:183**
* This new statement conflicts with `docs/reference/keyboard-shortcuts.md:19`, which still says section headers are skipped automatically. The implementation makes these rows navigable so `p` can target a nested multi-team header; please update the reference page in the same documentation change.
Section header rows are navigable at any depth — ↑ / ↓ can land on them. Pressing p while the cursor rests on a multi-team section header enters team pick mode, regardless of its nesting level.
**docs/usage/team-grouping.md:39**
* The new grammar makes a trailing `/` a malformed segment, but `README.md:87` still presents `--group-by-team-prefix platform/` as a valid example. That command emits the malformed-segment warning; please update the README example to use a valid one-level prefix or a complete chain.
A chain can have as many levels as you need (gamme-/squad-/chapter-, …). Malformed segments (a stray leading/trailing/double , or /) are dropped with a warning on stderr rather than silently producing an empty prefix.
**docs/usage/team-grouping.md:220**
* The path parser recognizes the literal separator ` > ` (including spaces); a no-space form such as `parent>combined` is treated as a bare label and will not resolve. Describing the separator as just `>` implies that form is valid. Please document the exact spaced separator.
- A fully-qualified path, joined with
>, when the label is ambiguous or you'd rather be explicit:
**docs/usage/team-grouping.md:263**
* The undo mockup is in an untagged code fence (` ``` `). This documentation requires every code block to declare a language; tag this terminal mockup as `text` so it renders as a literal example.
── squad-core + squad-mobile ← all repos restored
</details>
---
💡 <a href="/fulll/github-code-search/new/feat/team-hierarchy-cli?filename=.github/skills/code-review/SKILL.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add a `code-review` agent skill</a> or configure MCP servers for context-aware, tailored reviews. <a href="https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review#mcp-servers-and-agent-skills" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn more in the docs.</a>
| Nested levels render as consecutive markdown headings (`##`, `###`, `####`, …, capped at H6) — a sibling section that shares an ancestor with the previous one doesn't repeat that ancestor's heading: | ||
|
|
||
| ```text | ||
| 7 repos · 7 files · 8 matches selected |
- docs/usage/team-grouping.md: full rewrite covering the / and , chain grammar, per-level grouping algorithm, automatic nesting of overlapping team names, --group-by-team-prefix-consolidate (including its JSON-is-uncollapsed caveat), nested markdown/JSON output examples, indented TUI section mockups, and --pick-team at any depth (bare label auto-resolve vs fully-qualified "parent > combined" path). - docs/reference/cli-options.md: updated --group-by-team-prefix and --pick-team rows, added --group-by-team-prefix-consolidate. - CHANGELOG.md: added a pending v2.0.0 row linking to EPIC #125 — the actual version bump, tag, and required blog post (with user-provided highlights, per AGENTS.md) are deferred to the release step once all stacked PRs are merged to main. Part of EPIC #125. Closes #183.
shouze
force-pushed
the
feat/team-hierarchy-docs
branch
from
August 24, 2026 00:14
7178927 to
2f1de38
Compare
|
Coverage after merging feat/team-hierarchy-docs into feat/team-hierarchy-cli will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 similar comment
|
Coverage after merging feat/team-hierarchy-docs into feat/team-hierarchy-cli will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Summary
Documents the hierarchical team-prefix grouping feature built across
#177-#182, and prepares (but does not cut) the release entry for it.
docs/usage/team-grouping.md: full rewrite —/(nesting) and,(independent chains) grammar for--group-by-team-prefix, with examples.version, now applied recursively) and automatic nesting of overlapping
team names.
--group-by-team-prefix-consolidate, including the "JSON always getsthe uncollapsed hierarchy" caveat from the PR Wire hierarchical team grouping into the CLI end-to-end #190 review fix.
sectionpath example, and anindented TUI section mockup.
--pick-teamat any depth: bare-label auto-resolve vs. an explicit"parent > combined"path.docs/reference/cli-options.md: updated--group-by-team-prefix/--pick-teamrows, added--group-by-team-prefix-consolidate.CHANGELOG.md: added a_pending_v2.0.0row linking to EPIC EPIC: Hierarchical team-prefix grouping (multi-level headings) #125.Release is intentionally NOT cut in this PR
Per
AGENTS.md, actually cutting the release (bumpingpackage.json,writing the blog post, tagging) requires the user's interactively-provided
highlights and happens once all the stacked PRs in this EPIC are merged to
main— not before. This PR only prepares the documentation and achangelog placeholder so that step is straightforward later.
Closes #183
Validation
bun run docs:build(no dead-link warnings)bun run format:checkbun test(968 pass, unaffected by docs-only changes)bun run knip