Skip to content

docs(lark-doc): document poll blocks#1847

Open
SunPeiYang996 wants to merge 1 commit into
mainfrom
sun/poll-block-docxxml
Open

docs(lark-doc): document poll blocks#1847
SunPeiYang996 wants to merge 1 commit into
mainfrom
sun/poll-block-docxxml

Conversation

@SunPeiYang996

@SunPeiYang996 SunPeiYang996 commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • document structured poll creation and whole-block replacement for lark docs v2
  • document writable versus read-only poll fields and poll-voters references
  • clarify that publish-on-create keeps a draft and returns a warning when publishing fails
  • explain the poll_detail_unavailable export tip
  • remove the legacy top-level version key, which is rejected by the current skill frontmatter schema

Validation

quick_validate.py skills/lark-doc
Skill is valid!

This is documentation-only; CLI Go code is unchanged.

Summary by CodeRabbit

  • Documentation
    • Removed outdated version metadata from the skill documentation front-matter.
    • Clarified that replacing poll blocks uses full block replacement and that the new poll does not inherit prior block IDs, options/vote data, voters, publish time, or current user selections.
    • Expanded the XML reference with detailed <poll> tag guidance, supported attributes, publish-on-create behavior, read-only result fields, and handling when poll details are unavailable.

@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 10, 2026
@coderabbitai

coderabbitai Bot commented Jul 10, 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: 9d017fcd-07be-4535-8678-e39b9cff2c63

📥 Commits

Reviewing files that changed from the base of the PR and between 6f86034 and 38b3e12.

📒 Files selected for processing (3)
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-xml.md
💤 Files with no reviewable changes (1)
  • skills/lark-doc/SKILL.md
✅ Files skipped from review due to trivial changes (1)
  • skills/lark-doc/references/lark-doc-xml.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/lark-doc/references/lark-doc-update.md

📝 Walkthrough

Walkthrough

Updates lark-doc documentation by removing its version field and documenting <poll> XML attributes, lifecycle behavior, result fields, publishing failures, and full-block replacement semantics.

Changes

Poll documentation

Layer / File(s) Summary
Poll XML contract and lifecycle
skills/lark-doc/references/lark-doc-xml.md, skills/lark-doc/SKILL.md
Adds <poll> attributes, creation and publishing behavior, writable configuration, read-only result fields, unavailable-detail handling, and removes the documentation version field.
Poll replacement semantics
skills/lark-doc/references/lark-doc-update.md
Clarifies that poll replacement creates a new poll without inheriting prior identifiers, results, voters, timestamps, or selections, and can replace it with ordinary XML content.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: fangshuyu-768

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and directly describes the main change: documenting poll blocks for lark-doc.
Description check ✅ Passed It covers the summary, key changes, and validation, so the template's core required information is present.
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
  • Commit unit tests in branch sun/poll-block-docxxml

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.

@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.45%. Comparing base (0dd844c) to head (38b3e12).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1847   +/-   ##
=======================================
  Coverage   74.45%   74.45%           
=======================================
  Files         860      860           
  Lines       89906    89906           
=======================================
  Hits        66940    66940           
  Misses      17780    17780           
  Partials     5186     5186           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#sun/poll-block-docxxml -y -g

@SunPeiYang996
SunPeiYang996 force-pushed the sun/poll-block-docxxml branch from 6f86034 to 38b3e12 Compare July 10, 2026 05:12
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