Skip to content

fix(help): point root help Agent Skills link to README section#289

Merged
liangshuo-1 merged 1 commit into
larksuite:mainfrom
OwenYWT:codex/help-agent-skills-link
Apr 7, 2026
Merged

fix(help): point root help Agent Skills link to README section#289
liangshuo-1 merged 1 commit into
larksuite:mainfrom
OwenYWT:codex/help-agent-skills-link

Conversation

@OwenYWT

@OwenYWT OwenYWT commented Apr 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Fix the root help text so the "Learn more" link points to an existing README section.

Changes

  • replace the broken #install-ai-agent-skills anchor with #agent-skills
  • add a regression test to keep the root help link aligned with the README section

Test Plan

  • GOCACHE=/tmp/go-build-cache GOMODCACHE=/tmp/go-mod-cache /opt/homebrew/opt/go/bin/go test ./cmd/... ./internal/output

Summary by CodeRabbit

Release Notes

  • Documentation
    • Fixed the help text documentation link for "AI Agent Skills" to target the correct README section.

@coderabbitai

coderabbitai Bot commented Apr 7, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 73cb850f-2ba6-4db0-bf0e-74b116477b1c

📥 Commits

Reviewing files that changed from the base of the PR and between d3d92e3 and 67c57ef.

📒 Files selected for processing (2)
  • cmd/root.go
  • cmd/root_test.go

📝 Walkthrough

Walkthrough

The pull request updates a documentation link anchor in the help text from #install-ai-agent-skills to #agent-skills and adds a test to validate the change.

Changes

Cohort / File(s) Summary
Documentation Link Update
cmd/root.go
Updated rootLong help text anchor reference from #install-ai-agent-skills to #agent-skills.
Test Addition
cmd/root_test.go
Added TestRootLong_AgentSkillsLinkTargetsReadmeSection to verify the help text contains the correct anchor and excludes the old one.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A link was shifted in the help,
From old anchors to new ones so bright,
A test was written to ensure it stays right,
Simple, clean changes—no trouble or kelp! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: fixing the root help Agent Skills link to point to the correct README section.
Description check ✅ Passed The description covers the summary, changes, and test plan sections from the template, though the Related Issues section is omitted but not critical for this straightforward fix.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions github-actions Bot added the size/L Large or sensitive change across domains or core paths label Apr 7, 2026
@OwenYWT
OwenYWT marked this pull request as ready for review April 7, 2026 09:32
@greptile-apps

greptile-apps Bot commented Apr 7, 2026

Copy link
Copy Markdown

Greptile Summary

This PR fixes a broken anchor in the root help text by replacing #install-ai-agent-skills with #agent-skills, which matches the existing ## Agent Skills section in the README. A regression test is added to lock in the correct link and guard against future drift.

Confidence Score: 5/5

Safe to merge — minimal, correct fix with a regression test.

The change is a one-line URL anchor correction confirmed against the live README (## Agent Skills heading on line 129 generates the #agent-skills anchor). The new regression test directly validates both the presence of the new anchor and absence of the broken one. No logic, data, or security concerns.

No files require special attention.

Important Files Changed

Filename Overview
cmd/root.go URL anchor in AI Agent Skills help text corrected from #install-ai-agent-skills to #agent-skills, matching the live README section
cmd/root_test.go New regression test added to assert the correct anchor URL is present and the broken one is absent

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User runs lark-cli --help] --> B[rootLong string rendered]
    B --> C[AI Agent Skills section]
    C --> D["Learn more link\nhttps://github.com/larksuite/cli#agent-skills"]
    D --> E[README ## Agent Skills section]
    E --> F[Valid anchor ✓]

    OLD["Old broken anchor\n#install-ai-agent-skills"] -.->|removed| D
    TEST["TestRootLong_AgentSkillsLinkTargetsReadmeSection"] -->|validates| D
Loading

Reviews (1): Last reviewed commit: "fix(help): point root help Agent Skills ..." | Re-trigger Greptile

@liangshuo-1

Copy link
Copy Markdown
Collaborator

LGTM, thanks for the fix ! 🎉

@github-actions

github-actions Bot commented Apr 7, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@67c57ef1aa7e07dc52fd99518419a4b27892c7e2

🧩 Skill update

npx skills add OwenYWT/cli#codex/help-agent-skills-link -y -g

@liangshuo-1
liangshuo-1 merged commit d6fada0 into larksuite:main Apr 7, 2026
13 checks passed
tuxedomm pushed a commit to zhumiaoxin/cli that referenced this pull request Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants