Skip to content

docs: clarify okr progress children#1861

Open
ZEden0 wants to merge 2 commits into
larksuite:mainfrom
ZEden0:okr-progress-child-tags-lark-cli-main
Open

docs: clarify okr progress children#1861
ZEden0 wants to merge 2 commits into
larksuite:mainfrom
ZEden0:okr-progress-child-tags-lark-cli-main

Conversation

@ZEden0

@ZEden0 ZEden0 commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Clarify the supported direct child tags for <okr-progress> in the lark-doc XML extended block reference.
  • Document that <a> is only supported as an inline tag inside text/list content, not as a direct <okr-progress> child.
  • Document that <li> must be nested under <ol> / <ul>, not inserted directly under <okr-progress>.
  • Add an OKR progress example showing a list item containing an inline link.

Validation

  • Docs-only change.
  • Reviewed diff: skills/lark-doc/references/lark-doc-xml-extended-blocks.md only.
  • E2E passed for OKR progress child tags: 7/7 logical cases passed; final fetch verification passed.

Summary by CodeRabbit

  • Documentation
    • Expanded OKR block XML guidance with a new ul/li example showing links inside list items.
    • Updated okr-progress content rules to allow additional direct child elements, including source, ordered/unordered lists (ol/ul), and headings (h1h9).

@ZEden0 ZEden0 requested a review from SunPeiYang996 July 13, 2026 08:37
@github-actions github-actions Bot added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 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

Run ID: 7d7b9f39-eb59-4fd5-ae0a-5491464f20a1

📥 Commits

Reviewing files that changed from the base of the PR and between 803fb3b and d0b5a5c.

📒 Files selected for processing (1)
  • skills/lark-doc/references/lark-doc-xml-extended-blocks.md
💤 Files with no reviewable changes (1)
  • skills/lark-doc/references/lark-doc-xml-extended-blocks.md

📝 Walkthrough

Walkthrough

更新 OKR block 文档中的 XML 示例与 okr-progress 结构规则,补充列表项链接用法并扩展可直接承载的子节点类型。

Changes

OKR XML 文档

Layer / File(s) Summary
更新 OKR XML 结构规则
skills/lark-doc/references/lark-doc-xml-extended-blocks.md
新增列表项内链接示例,并将 okr-progress 支持的直接子节点扩展为 pcheckboxgridimgsourceolulh1h9

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

Possibly related PRs

Suggested reviewers: sunpeiyang996

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the summary, changes, and validation, but is missing a formal 'Test Plan' section with the checklist specified in the template. Add a 'Test Plan' section with the standard checklist items, or clarify how the documented E2E validation maps to the template's test plan requirements.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change—clarifying the supported child tags for okr-progress—which aligns with the primary objective of the pull request.
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

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.

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add ZEden0/cli#okr-progress-child-tags-lark-cli-main -y -g

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

Labels

domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant