Skip to content

fix(doc): Document the shipped SDK quick-start API - #253

Open
Inference1 wants to merge 2 commits into
iOfficeAI:mainfrom
Inference1:fix/250-sdk-readme-quickstart
Open

fix(doc): Document the shipped SDK quick-start API#253
Inference1 wants to merge 2 commits into
iOfficeAI:mainfrom
Inference1:fix/250-sdk-readme-quickstart

Conversation

@Inference1

Copy link
Copy Markdown

Fixes #250

Summary

  • Replace the nonexistent Doc wrapper examples with the shipped create/open and Document.send API.
  • Use parent for the slide add command, matching the batch-item command shape.

Verification

  • PYTHONPATH=sdk/python python3 -c "import officecli; print(officecli.Document)"
  • node --input-type=module -e "import * as sdk from "./sdk/node/index.js"; console.log(typeof sdk.create, typeof sdk.open)"
  • Executed both README workflows with the built CLI; each creates a deck, adds a slide, and reads it back.

@Inference1

Copy link
Copy Markdown
Author

@eric8810 Would you please review this pr?

@Inference1 Inference1 changed the title Document the shipped SDK quick-start API fix(Doc): Document the shipped SDK quick-start API Jul 22, 2026
@Inference1 Inference1 changed the title fix(Doc): Document the shipped SDK quick-start API fix(doc): Document the shipped SDK quick-start API Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README SDK quick-start imports a nonexistent Doc API in both Python and Node

1 participant