Skip to content

docs: document color methods#105

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-color-methods
Jul 20, 2026
Merged

docs: document color methods#105
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-color-methods

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

Summary

The README previously showed only a few color helpers, making the complete public API difficult to discover.

This PR documents every available color method, explains input and style composition, and links styleText to the official Node.js documentation.

Related Links

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c661c92f-3fa9-4f5c-8ac5-aa4e8ed7b489

📥 Commits

Reviewing files that changed from the base of the PR and between 5247f87 and b14b012.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated the README’s Color section to describe color as a wrapper around Node.js util.styleText. Added documentation for accepted input and output types, nested style composition, and a table of supported color methods and their visual effects.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the README documentation update for color methods.
Description check ✅ Passed The description matches the changeset by explaining the added API documentation and styleText reference.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-color-methods

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.

@chenjiahan
chenjiahan merged commit eeba57c into main Jul 20, 2026
4 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-color-methods branch July 20, 2026 08:17
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