docs: improve markdownify dependency explanation#35
Merged
Conversation
- Clarify that Markdownify enables AI to access unpublished content - Explain it's used when URLs are included in prompts - Add real-world example: AI Social Posts module workflow - Change "Optional Dependencies" to "Dependencies" in HTML - Make description more concise and actionable This better explains the actual technical function rather than the vague "enables internal links" description. Co-Authored-By: Claude <noreply@anthropic.com>
- Lead with technical function (provides markdown versions) - List general use cases (drafts, internal docs, unpublished content) - Mention AI Social Posts as example, not primary focus - Emphasize permission-respecting aspect
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
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
Improves the documentation for the Markdownify module dependency by clarifying its actual technical function and use cases.
Changes
Why
The previous description ("enables internal links to unpublished content") was vague and didn't explain:
.mdendpoint for contentBenefits
✅ Clearer understanding of dependency purpose
✅ Better explanation of technical function
✅ Real-world use case example
✅ More accurate for module page on Drupal.org