Problem/Motivation

AI Media keeps its documentation in a docs/ folder with images, published to GitLab Pages through mkdocs.yml. The rest of the Varbase documentation, including the Varbase AI Media Base recipe page, lives on docs.varbase.vardot.com (Vardot/varbase-docs). Two places to keep in step, and the module ships images it does not need.

Proposed resolution

  • Move the documentation to the AI Media module page on docs.varbase.vardot.com: Developers > Understanding Varbase > Varbase AI Modules > AI Media (a Vardot/varbase-docs pull request).
  • Remove docs/ (pages and images) and mkdocs.yml from the module.
  • Point the README, the code comment and the project page at the new documentation; the README image comes from the drupal.org project page.

AI-Generated: Yes

Remaining tasks

  • ✅ File an issue
  • ❌ Addition/Change/Update/Fix
  • ❌ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ❌ Developer Documentation support
  • ❌ User Guide Documentation support
  • ➖ UX/UI designer responsibilities
  • ➖ Accessibility and Readability
  • ❌ Reviewed by a human
  • ❌ Code review by maintainers
  • ❌ Full testing and approval
  • ❌ Credit contributors
  • ❌ Review with the product owner
  • ✅ Update Release Notes
  • ✅ Release

User interface changes

  • None.

API changes

  • None.

Data model changes

  • None.

Release notes snippet

  • The AI Media documentation moved to docs.varbase.vardot.com.

Issue fork ai_media-3634002

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed 6df7cca8 on 1.0.x
    task: #3634002 Move the documentation to docs.varbase.vardot.com and...
rajab natshah’s picture

Issue summary: View changes
Status: Active » Fixed
Issue tags: +ai_media-1.0.0-rc1

✅ Released ai_media-1.0.0-rc1

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.