docs: recommend file input as default for multiline markdown#8
Merged
Conversation
The 'Markdown content' section previously led with inline \n escaping and mentioned --<field>-file as a secondary option. For agents, this caused formatting bugs (escaped newlines rendered as literal text). Changes: - Lead with --<field>-file as the recommended approach - Show heredoc + file pattern (write to tmp, pass path) - Document the -file flag naming pattern (--body-file, --description-file, --content-file) - Demote inline strings to 'short, single-line content only' - Add practical examples: discussion post, project description, document
Rockyy174
approved these changes
May 14, 2026
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
2 participants
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.
The Markdown content section previously led with inline
\nescaping and mentioned--field-fileas a secondary option. In practice, agents hit formatting bugs with inline escaping (literal\ninstead of newlines).This PR makes file input the recommended default:
--<field>-fileand show the heredoc pattern--body-file,--description-file,--content-file)