Skip to content

docs: improve coding agent skill mention in README#987

Merged
sanchitmehtagit merged 1 commit into
mainfrom
docs/improve-agent-skill-mention
Jun 19, 2026
Merged

docs: improve coding agent skill mention in README#987
sanchitmehtagit merged 1 commit into
mainfrom
docs/improve-agent-skill-mention

Conversation

@sanchitmehtagit

@sanchitmehtagit sanchitmehtagit commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Improves the coding agent skill blurb added in #984:

  • Rewords to a question-style hook ("Migrating with a coding agent?") for better scannability
  • Links Claude Code and Cursor by name
  • Wraps the install command in a bash code block instead of inline code

Testing

Documentation-only change — no functional code modified.

Summary by CodeRabbit

  • Documentation
    • Updated v3 to v4 migration guidance with more detailed, step-by-step instructions for users of coding agents, including explicit command examples to help with the transition.

Rewords the blurb to a question-style hook, links Claude Code and Cursor,
and wraps the install command in a bash code block for clarity.
@sanchitmehtagit sanchitmehtagit requested a review from a team as a code owner June 19, 2026 08:49
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The README's v3→v4 migration section is updated: a single-sentence agent skill hint is replaced with a new "Migrating with a coding agent?" subsection containing an explicit fenced npx skills add auth0/agent-skills --skill auth0-android-major-migration command.

Changes

README Migration Guidance

Layer / File(s) Summary
Coding agent migration section rewrite
README.md
Replaces the previous one-line skill instruction with a "Migrating with a coding agent?" section and a fenced npx skills add command block.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • auth0/Auth0.Android#984: Both PRs update README.md to add or improve coding-agent guidance for the auth0-android-major-migration skill via npx skills add as part of the v3→v4 migration.

Suggested labels

documentation, review:tiny

Suggested reviewers

  • NandanPrabhu

Poem

🐇 Hop along, coding friends, the path is clear,
A fenced command block now guides you here.
npx skills add — the magic spell,
Android migration handled well.
This bunny approves with a joyful cheer! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately reflects the main change: improving documentation about coding agent skills in the README by adding explicit installation steps and better guidance.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ 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/improve-agent-skill-mention

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.

Comment thread README.md
**Migrating with a coding agent?** If you use [Claude Code](https://claude.ai/code) or [Cursor](https://cursor.com), add the Auth0.Android migration skill to automate the v3 → v4 upgrade:

```bash
npx skills add auth0/agent-skills --skill auth0-android-major-migration

@sanchitmehtagit sanchitmehtagit Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Wrapping the install command in a bash code block instead of inline code was inspired from here auth0/Auth0.swift#1212 (comment)

@sanchitmehtagit sanchitmehtagit added tiny Tiny review documentation This adds, fixes or improves documentation labels Jun 19, 2026
@sanchitmehtagit sanchitmehtagit merged commit b318778 into main Jun 19, 2026
7 checks passed
@sanchitmehtagit sanchitmehtagit deleted the docs/improve-agent-skill-mention branch June 19, 2026 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This adds, fixes or improves documentation tiny Tiny review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants