Skip to content

doc: Update documents. (#37) - #38

Merged
MinoruSekine merged 2 commits into
mainfrom
doc/37/update_doc
Jul 8, 2026
Merged

doc: Update documents. (#37)#38
MinoruSekine merged 2 commits into
mainfrom
doc/37/update_doc

Conversation

@MinoruSekine

@MinoruSekine MinoruSekine commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Closes #37

Summary by CodeRabbit

  • Documentation
    • Updated the CLI options guide to use capitalized option names consistently.
    • Added documentation for optional title and detail fields.
    • Documented support for button links via URL-based options.

@MinoruSekine MinoruSekine self-assigned this Jul 7, 2026
@MinoruSekine MinoruSekine added the documentation Improvements or additions to documentation label Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: MinoruSekine/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a9e2ea19-6d8a-4de3-b559-48c7aee2f208

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • ✅ Review completed - (🔄 Check again to review again)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc/37/update_doc

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.

@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 `@README.md`:
- Around line 30-31: Clarify the `-Link` and `-Url` option descriptions in the
README so they reflect the actual contract in the toast notification flow: each
flag is only optional as part of the pair, and both are required together when
enabling the link button. Update the wording near the `-Link`/`-Url` entries to
make this dependency explicit, matching the behavior enforced by the
implementation.
🪄 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: Repository: MinoruSekine/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7d8328e6-c27c-4dfe-adcd-998097c5b6dc

📥 Commits

Reviewing files that changed from the base of the PR and between 5e4924e and 4c72ffc.

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

Comment thread README.md Outdated
@MinoruSekine
MinoruSekine merged commit 0474ca9 into main Jul 8, 2026
5 checks passed
@MinoruSekine
MinoruSekine deleted the doc/37/update_doc branch July 8, 2026 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: Update documents.

1 participant