docs: clarify output shape and safe full-document packaging flow#2
Closed
stevenobiajulu wants to merge 1 commit intoAnsonLai:masterfrom
Closed
docs: clarify output shape and safe full-document packaging flow#2stevenobiajulu wants to merge 1 commit intoAnsonLai:masterfrom
stevenobiajulu wants to merge 1 commit intoAnsonLai:masterfrom
Conversation
Why:\nUsers integrating full-document workflows can confuse fragment/document/package payloads and accidentally write package-level XML into word/document.xml, producing unreadable DOCX files.\n\nWhat:\n- Adds an output-shape matrix by API\n- Adds do/don't packaging guidance\n- Adds explicit guardrails in AGENTS.md for <pkg:package> payloads\n- Points to extractReplacementNodesFromOoxml as the normalization helper\n\nRef: #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Thanks for maintaining this project. This PR is a docs-only clarification to reduce a packaging footgun I ran into while integrating full-document flows.
I may have misunderstood part of the output contract at first, so I framed this as guidance rather than an implementation claim.
What this changes
README.mdAGENTS.mdguardrails for<pkg:package>outputsWhy
Some API paths can return OOXML shapes that are not safe to write directly into
word/document.xml.An explicit note and helper pointer (
extractReplacementNodesFromOoxml) should help prevent unreadable DOCX outputs from integration misuse.Scope
Related issue: #1