Skip to content

docs(skills): update queue-dashboard.md for Clanker Control Panel#397

Open
castrojo wants to merge 2 commits into
mainfrom
docs/queue-dashboard-update
Open

docs(skills): update queue-dashboard.md for Clanker Control Panel#397
castrojo wants to merge 2 commits into
mainfrom
docs/queue-dashboard-update

Conversation

@castrojo
Copy link
Copy Markdown
Contributor

@castrojo castrojo commented Jun 2, 2026

Updates docs/skills/queue-dashboard.md with all changes from recent sessions:

  • New name: Clanker Control Panel
  • Add review-guide.md URL — machine-readable reviewer briefing
  • Add data.json URL for machine/agent consumption
  • Document approval count display on PR cards
  • Document 10-min cron cadence (was hourly)
  • Document data architecture (file cache → data.json → browser 5-min refresh)
  • Add theme toggle mention
  • Add pointer to agentic-contributing guide

Note: this branch is based on #394 (docs/session-e2e-queue-knowledge) which hasn't merged yet — it includes docs/skills/INDEX.md, e2e-ci.md, and queue-dashboard.md from that PR. Consider merging #394 first or squashing together.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Agent skills documentation including an index page, a guide for investigating E2E CI test failures with details on execution environment and known issues, and a Queue Dashboard reference explaining dashboard features, PR tier mapping, merge rules, and system architecture.

castrojo and others added 2 commits June 2, 2026 01:49
Documents knowledge captured during 2026-06-02 review session:

- e2e-ci.md: common suite SSH model, brew tools masked in CI, MOTD fix
  (testsuite PR #208), quarantined scenarios (zsh/fish/brew-tools, issue #210)
- queue-dashboard.md: queue.projectbluefin.io PR tiers, common merge ruleset
  (2 approvals required, only Build+push is a required check)
- INDEX.md: skill docs index

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Assisted-by: Claude Sonnet 4.6 via GitHub Copilot
- Rename to Clanker Control Panel throughout
- Add review-guide.md URL (machine-readable reviewer briefing)
- Add data.json URL for machine consumption
- Document approval count display on PR cards
- Document 10-min cron cadence (was hourly)
- Document data architecture (file cache, data.json, browser 5-min refresh)
- Add theme toggle mention
- Add pointer to agentic-contributing guide

Assisted-by: Claude Sonnet 4.6 via GitHub Copilot
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces three new documentation pages under docs/skills/. An index page links to references for the E2E CI common suite (explaining SSH execution, known failures, and tested images) and the Queue Dashboard (describing its architecture, refresh behavior, and PR tier mapping).

Changes

Agent skill documentation

Layer / File(s) Summary
Skills documentation index
docs/skills/INDEX.md
Index page introducing the skills documentation structure with links to three skill reference documents.
E2E CI common suite reference
docs/skills/e2e-ci.md
Complete reference documentation for the post-merge E2E common suite, covering test execution via SSH, known quarantined failures (brew CLI and shell PATH issues), a previously fixed MOTD assertion, and tested container images.
Queue dashboard reference
docs/skills/queue-dashboard.md
Reference documentation for the Queue Dashboard, describing stats display, refresh behavior, PR tier mapping, merge ruleset, data architecture flow, and tracked repositories.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit hops through docs so neat,
Three new skills make the suite complete,
With dashboards, CI, and indexes bright,
The knowledge base takes perfect flight! 🐰✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions updating queue-dashboard.md for Clanker Control Panel, but the PR actually adds three new documentation files (INDEX.md, e2e-ci.md, and queue-dashboard.md) with the title only reflecting one file's rename. Update the title to reflect the primary objective: adding new skill documentation files (INDEX, e2e-ci, queue-dashboard) or clarify the main scope of these changes.
Description check ❓ Inconclusive The PR description covers the queue-dashboard updates comprehensively but does not mention the addition of INDEX.md and e2e-ci.md files that are included in this PR according to the raw summary. Clarify whether this PR only updates queue-dashboard or also includes the new INDEX.md and e2e-ci.md files; update description to match the actual changeset scope.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/queue-dashboard-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. kind/documentation Improvements or additions to documentation labels Jun 2, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (3)
docs/skills/queue-dashboard.md (2)

26-30: 💤 Low value

Consider adding language specifier to code block.

The fenced code block showing GitHub search filters would benefit from a language specifier for better rendering.

📝 Proposed fix
-```
+```text
 is:pr is:open -is:draft status:success review:approved   → ✅ Approved (ready to merge)
 is:pr is:open -is:draft status:success review:required   → ⏳  Needs reviews
 is:pr is:open -is:draft status:success review:none       → ○  No reviews yet
</details>

As per coding guidelines, markdownlint-cli2 flags fenced code blocks without a language specified (MD040).

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/skills/queue-dashboard.md around lines 26 - 30, The fenced code block
containing the GitHub search filters (the lines starting with "is:pr is:open
-is:draft status:success review:...") is missing a language specifier and
triggers markdownlint MD040; update that code fence to include a language tag
(e.g., "text") so it becomes text ... , preserving the contents exactly
and leaving surrounding markdown unchanged.


</details>

---

`55-64`: _💤 Low value_

**Consider adding language specifier to code block.**

The data architecture diagram would be clearer with a language specifier such as `text` or `mermaid`.




<details>
<summary>📝 Proposed fix</summary>

```diff
-```
+```text
 GitHub API (every 10 min, GHA cron)
   → generate.js (25-min file TTL cache layer)
   → data.json  ← committed to repo root, served as static asset
```
</details>

As per coding guidelines, markdownlint-cli2 flags fenced code blocks without a language specified (MD040).

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/skills/queue-dashboard.md around lines 55 - 64, The fenced code block
containing the architecture diagram (the block that starts with "GitHub API
(every 10 min, GHA cron)" and includes references like generate.js, data.json
and DATA) lacks a language specifier and triggers MD040; add an appropriate
language tag (e.g., text or mermaid) to the opening fence (change totext
or ```mermaid) so markdownlint-cli2 passes while preserving the exact block
contents.


</details>

</blockquote></details>
<details>
<summary>docs/skills/e2e-ci.md (1)</summary><blockquote>

`27-29`: _⚡ Quick win_

**Add language specifier to code block.**

The fenced code block should specify a language for proper syntax highlighting and markdown compliance.




<details>
<summary>📝 Proposed fix</summary>

```diff
-```
+```text
 systemd.mask=brew-setup.service
 ```
```
</details>

As per coding guidelines, markdownlint-cli2 flags fenced code blocks without a language specified (MD040).

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/skills/e2e-ci.md around lines 27 - 29, The fenced code block containing
"systemd.mask=brew-setup.service" lacks a language specifier; update that block
to include a language (e.g., "text" or "ini") so markdownlint MD040 is satisfied
and syntax highlighting is applied—locate the fenced block around the
"systemd.mask=brew-setup.service" line and change the opening fence from ``` to

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/skills/e2e-ci.md`:
- Line 7: Update the incorrect workflow path string
"common/.github/workflows/e2e.yml" in docs/skills/e2e-ci.md to reference the
actual repository location by replacing it with
"projectbluefin/common/.github/workflows/e2e.yml" so the documentation points to
the correct reusable workflow file.

In `@docs/skills/INDEX.md`:
- Line 7: The INDEX entry referencing hive-review.md in docs/skills/INDEX.md is
pointing to a non-existent file; either add the missing hive-review.md to the
repo or update the link text to the correct existing filename or path (e.g.,
replace "hive-review.md" with the actual filename/path that fd found) so the
relative link resolves; update the table row that currently contains
"[hive-review.md](hive-review.md)" accordingly.

---

Nitpick comments:
In `@docs/skills/e2e-ci.md`:
- Around line 27-29: The fenced code block containing
"systemd.mask=brew-setup.service" lacks a language specifier; update that block
to include a language (e.g., "text" or "ini") so markdownlint MD040 is satisfied
and syntax highlighting is applied—locate the fenced block around the
"systemd.mask=brew-setup.service" line and change the opening fence from ``` to
```text (or another appropriate language).

In `@docs/skills/queue-dashboard.md`:
- Around line 26-30: The fenced code block containing the GitHub search filters
(the lines starting with "is:pr is:open -is:draft status:success review:...") is
missing a language specifier and triggers markdownlint MD040; update that code
fence to include a language tag (e.g., "text") so it becomes ```text ... ```,
preserving the contents exactly and leaving surrounding markdown unchanged.
- Around line 55-64: The fenced code block containing the architecture diagram
(the block that starts with "GitHub API (every 10 min, GHA cron)" and includes
references like generate.js, data.json and __DATA__) lacks a language specifier
and triggers MD040; add an appropriate language tag (e.g., text or mermaid) to
the opening fence (change ``` to ```text or ```mermaid) so markdownlint-cli2
passes while preserving the exact block contents.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 464bf174-0208-4383-b6c2-f3ad6523f9a3

📥 Commits

Reviewing files that changed from the base of the PR and between bb7b2e4 and 34befc8.

📒 Files selected for processing (3)
  • docs/skills/INDEX.md
  • docs/skills/e2e-ci.md
  • docs/skills/queue-dashboard.md

Comment thread docs/skills/e2e-ci.md

## How the common suite runs

The common post-merge E2E (`common/.github/workflows/e2e.yml`) calls the reusable
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Correct the workflow path.

The path common/.github/workflows/e2e.yml is incorrect. The file is located at .github/workflows/e2e.yml within the projectbluefin/common repository. The common/ prefix should not be part of the path.

📝 Proposed fix
-The common post-merge E2E (`common/.github/workflows/e2e.yml`) calls the reusable
+The common post-merge E2E (`.github/workflows/e2e.yml`) calls the reusable
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The common post-merge E2E (`common/.github/workflows/e2e.yml`) calls the reusable
The common post-merge E2E (`.github/workflows/e2e.yml`) calls the reusable
🧰 Tools
🪛 LanguageTool

[uncategorized] ~7-~7: The official name of this software platform is spelled with a capital “H”.
Context: ... suite runs The common post-merge E2E (common/.github/workflows/e2e.yml) calls the reusable ...

(GITHUB)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/skills/e2e-ci.md` at line 7, Update the incorrect workflow path string
"common/.github/workflows/e2e.yml" in docs/skills/e2e-ci.md to reference the
actual repository location by replacing it with
"projectbluefin/common/.github/workflows/e2e.yml" so the documentation points to
the correct reusable workflow file.

Comment thread docs/skills/INDEX.md

| File | What it covers |
|---|---|
| [hive-review.md](hive-review.md) | `~/src/hive-status` — session start, P0/P1 triage, hive label taxonomy |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if hive-review.md exists in docs/skills/

fd -t f 'hive-review.md' docs/skills/

Repository: projectbluefin/common

Length of output: 47


Fix broken link in docs/skills/INDEX.md to hive-review.md

fd -t f 'hive-review.md' docs/skills/ returns no matches in the current repo state, so the index entry’s hive-review.md relative link appears to be broken unless that file is added by this PR (or the link is adjusted).

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/skills/INDEX.md` at line 7, The INDEX entry referencing hive-review.md
in docs/skills/INDEX.md is pointing to a non-existent file; either add the
missing hive-review.md to the repo or update the link text to the correct
existing filename or path (e.g., replace "hive-review.md" with the actual
filename/path that fd found) so the relative link resolves; update the table row
that currently contains "[hive-review.md](hive-review.md)" accordingly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant