Skip to content

fix: rename report to deep in industry-research skill#8

Open
sidneyswift wants to merge 2 commits intomainfrom
fix/rename-report-to-deep
Open

fix: rename report to deep in industry-research skill#8
sidneyswift wants to merge 2 commits intomainfrom
fix/rename-report-to-deep

Conversation

@sidneyswift
Copy link
Copy Markdown
Contributor

@sidneyswift sidneyswift commented Apr 5, 2026

Summary

Updates industry-research skill to use deep instead of report — matching the CLI rename in cli#20.

4 references updated:

  • SKILL.md line 30: report "[entity]"deep "[entity]"
  • SKILL.md line 76: recoup research reportrecoup research deep
  • SKILL.md line 155: fall back to web or reportfall back to web or deep
  • references/workflows.md line 283: insights, web, reportinsights, web, deep

Made with Cursor


Summary by cubic

Renamed the narrative research command from report to deep in the industry-research skill to match the CLI and keep examples consistent. Also removed vendor branding and added the recoup-research skill doc with full CLI guidance.

  • Bug Fixes

    • Replaced report with deep in skills/industry-research/SKILL.md and skills/industry-research/references/workflows.md; removed Chartmetric mentions to keep docs provider‑agnostic.
  • New Features

    • Added recoup-research/SKILL.md with CLI quick reference, decision tree, synthesis patterns, and workflows.

Written for commit 9b800fd. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for the recoup research CLI skill: auth expectations, decision tree for common research intents, command quick-reference, data interpretation tips, saving results, and graceful-degradation guidance.
    • Updated examples and workflow docs to use the deep command for narrative entity research instead of report.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 5, 2026

📝 Walkthrough

Walkthrough

Adds a new recoup-research/SKILL.md CLI skill doc and updates industry-research docs to replace report with deep in examples and workflow guidance for entity-focused commands.

Changes

Cohort / File(s) Summary
New Recoup Research Skill
recoup-research/SKILL.md
Adds a new CLI skill doc defining recoup research: auth via RECOUP_API_KEY, prerequisites to avoid redundant research, decision tree mapping common user intents to CLI commands, command quick reference (artist data, non-artist lookups, web intelligence), platform/source notes, data interpretation guidance, saving to research/, and graceful-degradation/“what not to do” guidance.
Industry Research Updates
skills/industry-research/SKILL.md, skills/industry-research/references/workflows.md
Replaces report with deep for the narrative "Tell me about [entity]" examples and related workflow text; adjusts fallback/graceful-degradation wording (use web or deep where report was referenced) and clarifies YouTube audience platform phrasing.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • sweetmantech

Poem

🐰 I hopped through docs with careful peep,

Swapped a word and made the path leap.
Deep now tells tales where reports once stood,
Research paths tidy, clear, and good.
🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: updating industry-research skill documentation to rename 'report' command references to 'deep' across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 fix/rename-report-to-deep

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.

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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@recoup-research/SKILL.md`:
- Around line 141-143: The fenced code block in SKILL.md is missing a language
identifier (markdownlint MD040); update the backticks for the block that
contains "research/artist-intel-2026-03-27.md" to include a language tag (e.g.
change ``` to ```text or ```md) so markdownlint stops warning and the file
renders with the intended code block language.
- Line 30: Update the stale command references in recoup-research/SKILL.md by
replacing every occurrence of the `report "[entity]"` invocation with `deep
"[entity]"` (three instances noted), and adjust any adjacent explanatory text if
it explicitly names the old `report` command so it matches the new `deep` usage;
search for the literal `report "[entity]"` and update to `deep "[entity]"` to
keep this file consistent with skills/industry-research/SKILL.md.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9aed8e2d-81b6-4a47-9722-8629f7894466

📥 Commits

Reviewing files that changed from the base of the PR and between be5c2a9 and e92f03a.

📒 Files selected for processing (3)
  • recoup-research/SKILL.md
  • skills/industry-research/SKILL.md
  • skills/industry-research/references/workflows.md


**"Find me [people]"** → `people "A&R reps at [label]"`

**"Tell me about [entity]"** → `enrich "[entity]" --schema '{...}'` for structured data, or `report "[entity]"` for a narrative
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 | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify stale narrative command references across skills docs.
rg -nP 'recoup research report|`report\b|or `report`' --type=md

Repository: recoupable/skills

Length of output: 512


🏁 Script executed:

# Check if industry-research SKILL.md exists and uses `deep`
fd -t f "SKILL.md" | head -20

Repository: recoupable/skills

Length of output: 422


🏁 Script executed:

# Look for `deep` command usage in skills documentation
rg -nP '`deep\b|recoup research deep' --type=md

Repository: recoupable/skills

Length of output: 711


🏁 Script executed:

# Check for any CLI or main documentation about the rename
fd -t f "README|CHANGELOG|\.md" | xargs rg -l "report|deep" | head -10

Repository: recoupable/skills

Length of output: 367


🏁 Script executed:

# Compare the two SKILL.md files to understand the relationship
echo "=== recoup-research/SKILL.md (lines 25-35) ===" && sed -n '25,35p' recoup-research/SKILL.md
echo -e "\n=== skills/industry-research/SKILL.md (lines 25-35) ===" && sed -n '25,35p' skills/industry-research/SKILL.md

Repository: recoupable/skills

Length of output: 1116


🏁 Script executed:

# Check file creation/modification context and directory structure
echo "=== Directory structure ===" && ls -la recoup-research/ | head -10 && echo "---" && ls -la skills/industry-research/ | head -10

Repository: recoupable/skills

Length of output: 496


Update report command references to deep in recoup-research/SKILL.md.

Lines 30, 76, and 155 document the stale report command, which conflicts with the updated skills/industry-research/SKILL.md that uses deep. Update all three occurrences:

Required changes
-**"Tell me about [entity]"** → `enrich "[entity]" --schema '{...}'` for structured data, or `report "[entity]"` for a narrative
+**"Tell me about [entity]"** → `enrich "[entity]" --schema '{...}'` for structured data, or `deep "[entity]"` for a narrative
-recoup research report "Tell me about Drake" --json          # deep research — { content: "markdown report", citations: [...] }
+recoup research deep "Tell me about Drake" --json            # deep research — { content: "markdown report", citations: [...] }
-- **Don't assume Chartmetric has every artist.** If search returns no results, fall back to `web` or `report`.
+- **Don't assume Chartmetric has every artist.** If search returns no results, fall back to `web` or `deep`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@recoup-research/SKILL.md` at line 30, Update the stale command references in
recoup-research/SKILL.md by replacing every occurrence of the `report
"[entity]"` invocation with `deep "[entity]"` (three instances noted), and
adjust any adjacent explanatory text if it explicitly names the old `report`
command so it matches the new `deep` usage; search for the literal `report
"[entity]"` and update to `deep "[entity]"` to keep this file consistent with
skills/industry-research/SKILL.md.

Comment on lines +141 to +143
```
research/artist-intel-2026-03-27.md
```
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

Add a language to the fenced code block (markdownlint MD040).

This block is missing a language identifier; markdownlint will keep warning on it.

Suggested doc fix
-```
+```text
 research/artist-intel-2026-03-27.md
</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>

[warning] 141-141: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

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

Verify each finding against the current code and only fix it if needed.

In @recoup-research/SKILL.md around lines 141 - 143, The fenced code block in
SKILL.md is missing a language identifier (markdownlint MD040); update the
backticks for the block that contains "research/artist-intel-2026-03-27.md" to
include a language tag (e.g. change totext or ```md) so markdownlint
stops warning and the file renders with the intended code block language.


</details>

<!-- fingerprinting:phantom:triton:hawk:b914894e-5b27-4eef-b7bf-9ea5ace4bc71 -->

<!-- This is an auto-generated comment by CodeRabbit -->

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

3 issues found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="recoup-research/SKILL.md">

<violation number="1" location="recoup-research/SKILL.md:30">
P1: This `report` was not renamed to `deep`. The PR description explicitly lists this as one of the 4 references to update, but the change was not applied.</violation>

<violation number="2" location="recoup-research/SKILL.md:76">
P1: This `report` command was not renamed to `deep`. The PR description lists this as one of the 4 references to update, but the change was not applied. The comment even says "# deep research" while the command itself still says `report`.</violation>

<violation number="3" location="recoup-research/SKILL.md:155">
P1: This `report` was not renamed to `deep`. The PR description lists this as one of the 4 references to update, but the change was not applied.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.

- **Don't dump raw JSON to the user.** Interpret the data and draw conclusions.
- **Don't re-research what `context/artist.md` already covers.** Read it first.
- **Don't ignore the `--json` flag when chaining.** Tables are for humans, JSON is for you.
- **Don't assume Chartmetric has every artist.** If search returns no results, fall back to `web` or `report`.
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot Apr 5, 2026

Choose a reason for hiding this comment

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

P1: This report was not renamed to deep. The PR description lists this as one of the 4 references to update, but the change was not applied.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At recoup-research/SKILL.md, line 155:

<comment>This `report` was not renamed to `deep`. The PR description lists this as one of the 4 references to update, but the change was not applied.</comment>

<file context>
@@ -0,0 +1,168 @@
+- **Don't dump raw JSON to the user.** Interpret the data and draw conclusions.
+- **Don't re-research what `context/artist.md` already covers.** Read it first.
+- **Don't ignore the `--json` flag when chaining.** Tables are for humans, JSON is for you.
+- **Don't assume Chartmetric has every artist.** If search returns no results, fall back to `web` or `report`.
+
+---
</file context>
Fix with Cubic


```bash
recoup research web "Drake brand partnerships" --json # web search — { results: [{ title, url, snippet }] }
recoup research report "Tell me about Drake" --json # deep research — { content: "markdown report", citations: [...] }
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot Apr 5, 2026

Choose a reason for hiding this comment

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

P1: This report command was not renamed to deep. The PR description lists this as one of the 4 references to update, but the change was not applied. The comment even says "# deep research" while the command itself still says report.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At recoup-research/SKILL.md, line 76:

<comment>This `report` command was not renamed to `deep`. The PR description lists this as one of the 4 references to update, but the change was not applied. The comment even says "# deep research" while the command itself still says `report`.</comment>

<file context>
@@ -0,0 +1,168 @@
+
+```bash
+recoup research web "Drake brand partnerships" --json              # web search — { results: [{ title, url, snippet }] }
+recoup research report "Tell me about Drake" --json          # deep research — { content: "markdown report", citations: [...] }
+recoup research people "A&R reps at Atlantic Records" --json       # people search — { results: [{ title, url, summary }] }
+recoup research extract "https://example.com" --json               # URL scraping — { results: [{ title, url, excerpts: [...] }] }
</file context>
Fix with Cubic


**"Find me [people]"** → `people "A&R reps at [label]"`

**"Tell me about [entity]"** → `enrich "[entity]" --schema '{...}'` for structured data, or `report "[entity]"` for a narrative
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot Apr 5, 2026

Choose a reason for hiding this comment

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

P1: This report was not renamed to deep. The PR description explicitly lists this as one of the 4 references to update, but the change was not applied.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At recoup-research/SKILL.md, line 30:

<comment>This `report` was not renamed to `deep`. The PR description explicitly lists this as one of the 4 references to update, but the change was not applied.</comment>

<file context>
@@ -0,0 +1,168 @@
+
+**"Find me [people]"** → `people "A&R reps at [label]"`
+
+**"Tell me about [entity]"** → `enrich "[entity]" --schema '{...}'` for structured data, or `report "[entity]"` for a narrative
+
+**"What does this page say?"** → `extract "https://..."` 
</file context>
Fix with Cubic

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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@skills/industry-research/SKILL.md`:
- Line 76: Update the inline output description for the `deep` example
invocation so it no longer uses the old term "markdown report"; locate the
example line containing `recoup research deep "Tell me about Drake" --json` in
SKILL.md and replace the `markdown report` wording with a neutral term such as
`markdown narrative` (or another preferred synonym) so the example output
description matches the renamed `deep` command.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2f9aacc9-e80b-46db-adb3-93177b066203

📥 Commits

Reviewing files that changed from the base of the PR and between e92f03a and 9b800fd.

📒 Files selected for processing (1)
  • skills/industry-research/SKILL.md

```bash
recoup research web "Drake brand partnerships" --json # web search — { results: [{ title, url, snippet }] }
recoup research report "Tell me about Drake" --json # deep research — { content: "markdown report", citations: [...] }
recoup research deep "Tell me about Drake" --json # deep research — { content: "markdown report", citations: [...] }
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

Rename lingering “report” wording in deep example output.

The command is correctly renamed to deep, but the inline output description still says markdown report, which reintroduces old terminology. Consider changing it to neutral wording like markdown narrative for consistency.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@skills/industry-research/SKILL.md` at line 76, Update the inline output
description for the `deep` example invocation so it no longer uses the old term
"markdown report"; locate the example line containing `recoup research deep
"Tell me about Drake" --json` in SKILL.md and replace the `markdown report`
wording with a neutral term such as `markdown narrative` (or another preferred
synonym) so the example output description matches the renamed `deep` command.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant