Skip to content

docs: improve markdownify dependency explanation#35

Merged
jjroelofs merged 2 commits into1.xfrom
docs/improve-markdownify-explanation
Oct 18, 2025
Merged

docs: improve markdownify dependency explanation#35
jjroelofs merged 2 commits into1.xfrom
docs/improve-markdownify-explanation

Conversation

@jjroelofs
Copy link
Copy Markdown
Contributor

Summary

Improves the documentation for the Markdownify module dependency by clarifying its actual technical function and use cases.

Changes

  • README.md: Updated Markdownify description to explain it enables AI to access unpublished Drupal content when URLs are included in prompts
  • docs/ckeditor_ai_agent_desc.html:
    • Changed "Optional Dependencies" → "Dependencies"
    • Added detailed explanation with real-world example (AI Social Posts module)
    • Clarified it provides markdown versions of internal content respecting user permissions

Why

The previous description ("enables internal links to unpublished content") was vague and didn't explain:

  • When it's used: When users include Drupal URLs in AI prompts
  • How it works: Provides .md endpoint for content
  • Real use case: AI Social Posts module generating posts for draft articles

Benefits

✅ Clearer understanding of dependency purpose
✅ Better explanation of technical function
✅ Real-world use case example
✅ More accurate for module page on Drupal.org

- 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>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 18, 2025
- 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
@jjroelofs jjroelofs merged commit 1d34c0d into 1.x Oct 18, 2025
4 checks passed
@jjroelofs jjroelofs deleted the docs/improve-markdownify-explanation branch October 18, 2025 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant