Skip to content

docs(skills): fix broken reference links - #2485

Open
dajiaohuang wants to merge 1 commit into
larksuite:mainfrom
dajiaohuang:docs/2480-fix-skill-links
Open

docs(skills): fix broken reference links#2485
dajiaohuang wants to merge 1 commit into
larksuite:mainfrom
dajiaohuang:docs/2480-fix-skill-links

Conversation

@dajiaohuang

@dajiaohuang dajiaohuang commented Aug 24, 2026

Copy link
Copy Markdown

Summary

Repair eight relative links in shipped mail and app skill guidance so every referenced Markdown file resolves inside the installed skill tree.

Changes

  • Fix six mail-compose references that accidentally added a second references/ segment.
  • Point the local app workflow at the actual creative-design.md entry.
  • Point mail watch at the existing generic lark-event/SKILL.md guidance.

Test Plan

  • Resolved every local Markdown link in the eight changed files; 0 missing targets
  • node scripts/skill-format-check/index.js
  • git diff --check origin/main...HEAD
  • Manual local verification confirms each corrected target exists

Related Issues

Summary by CodeRabbit

  • Documentation
    • Corrected guidance links for HTML-based app development workflows.
    • Updated email drafting, editing, forwarding, replying, sending, and monitoring instructions to point to the appropriate local documentation.
    • Refreshed event subscription guidance to reference the current documentation.
    • Improved the reliability of required pre-task reading and workflow instructions.

@github-actions github-actions Bot added domain/mail PR touches the mail domain size/L Large or sensitive change across domains or core paths labels Aug 24, 2026
@coderabbitai

coderabbitai Bot commented Aug 24, 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: 63dda075-2e38-45be-a222-9f0ea423cc68

📥 Commits

Reviewing files that changed from the base of the PR and between 35bd5ec and 491f0e4.

📒 Files selected for processing (8)
  • skills/lark-apps/references/lark-apps-local-dev.md
  • skills/lark-mail/references/lark-mail-draft-create.md
  • skills/lark-mail/references/lark-mail-draft-edit.md
  • skills/lark-mail/references/lark-mail-forward.md
  • skills/lark-mail/references/lark-mail-reply-all.md
  • skills/lark-mail/references/lark-mail-reply.md
  • skills/lark-mail/references/lark-mail-send.md
  • skills/lark-mail/references/lark-mail-watch.md

Included review availability: Your plan provides up to 10 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

Eight broken relative links in shipped skill references now point to existing documentation files. The changes cover six mail workflows, the local app-development workflow, and the mail event-watch workflow.

Changes

Skill reference links

Layer / File(s) Summary
Mail guidance links
skills/lark-mail/references/lark-mail-draft-create.md, skills/lark-mail/references/lark-mail-draft-edit.md, skills/lark-mail/references/lark-mail-forward.md, skills/lark-mail/references/lark-mail-reply-all.md, skills/lark-mail/references/lark-mail-reply.md, skills/lark-mail/references/lark-mail-send.md
The six mail references now link to the local lark-mail-html.md document.
App and event workflow links
skills/lark-apps/references/lark-apps-local-dev.md, skills/lark-mail/references/lark-mail-watch.md
The app workflow now links to creative-design/creative-design.md. The mail watch workflow now links to lark-event/SKILL.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 491f0

This change only repairs broken references in shipped skill guidance, with the corrected targets verified and no actionable merge-blocking risk remaining.

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: repairing broken documentation reference links.
Description check ✅ Passed The description includes the required summary, changes, test plan, and related issue sections with specific details.
Linked Issues check ✅ Passed The eight link corrections match all coding objectives in issue #2480, including the six mail links and two workflow links.
Out of Scope Changes check ✅ Passed All listed changes directly repair the broken links identified in issue #2480, with no unrelated changes indicated.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (8 skipped: 8 unsupported.)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/mail PR touches the mail domain size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix eight broken links in shipped skill references

1 participant