Skip to content

docs: recommend Superpowers companion - #16

Merged
wenn-id merged 2 commits into
mainfrom
docs/recommend-superpowers
Jul 31, 2026
Merged

docs: recommend Superpowers companion#16
wenn-id merged 2 commits into
mainfrom
docs/recommend-superpowers

Conversation

@wenn-id

@wenn-id wenn-id commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • recommend Superpowers for structured brainstorming, planning, debugging, and verification
  • clarify that it is optional, separately installed, and not bundled or required
  • add regression coverage for the documentation contract

Validation

  • python -m unittest tests.test_validation.PackagingTests -v
  • python -m unittest discover -s tests -v — 342 passed, 1 skipped
  • Superpowers repository URL returned HTTP 200
  • git diff --check

Summary by CodeRabbit

  • Documentation

    • Added installation guidance for the optional Superpowers companion, including its benefits and separate installation requirements.
    • Clarified that Superpowers is not bundled with or required by Comic Sol.
  • Tests

    • Added coverage to verify the optional companion guidance appears consistently in project documentation.
    • Confirmed packaging and dependency files do not include Superpowers references.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8539911a-7288-4a02-9097-e839fadf0083

📥 Commits

Reviewing files that changed from the base of the PR and between 0e88de6 and e8c91df.

📒 Files selected for processing (1)
  • tests/test_validation.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/test_validation.py

📝 Walkthrough

Walkthrough

The installation documentation now recommends Superpowers as an optional, separately installed companion. A validation test checks the recommendation and confirms that Comic Sol does not require or bundle Superpowers.

Changes

Optional Superpowers documentation

Layer / File(s) Summary
Document and validate the optional companion
README.md, docs/install.md, tests/test_validation.py
The installation documentation recommends Superpowers for structured workflows. The test checks the link, optional status, separate installation wording, explicit non-requirement statements, and the absence of Superpowers references in packaging files.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation change to recommend Superpowers as an optional companion.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/recommend-superpowers

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/test_validation.py`:
- Around line 995-1004: Extend
test_install_docs_recommend_superpowers_without_making_it_a_dependency to
inspect the repository’s dependency manifests and packaging inputs, asserting
they do not reference Superpowers or its repository URL. If those inputs are
intentionally out of scope, rename the test to clearly indicate it covers
documentation only.
🪄 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 Plus

Run ID: 1c8a84cc-ffea-471b-9bca-8718a0c57ad6

📥 Commits

Reviewing files that changed from the base of the PR and between ac62941 and 0e88de6.

📒 Files selected for processing (3)
  • README.md
  • docs/install.md
  • tests/test_validation.py

Comment thread tests/test_validation.py
@wenn-id
wenn-id merged commit 38a14c8 into main Jul 31, 2026
8 checks passed
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