Problem/Motivation

The docs/ directory and all documentation pages exist in the repository, but there is no mkdocs.yml file. Without it, the DrupalCI pages job included via
include.drupalci.main.yml cannot build or publish the documentation.

Proposed resolution

Add a mkdocs.yml at the project root using the MkDocs Material theme, configured with the site name, repo URL, and a nav structure that reflects the existing docs/ directory hierarchy.

  • Add mkdocs.yml with site name, repo URL, Material theme, and nav structure reflecting the existing docs/ hierarchy

Remaining tasks

  • ✅ File an issue
  • ✅ Addition/Change/Update/Fix
  • ✅ Testing to ensure no regression
  • ✅ Automated unit testing coverage
  • ✅ Automated functional testing coverage
  • ➖ UX/UI designer responsibilities
  • ✅ Readability
  • ✅ Accessibility
  • ✅ Performance
  • ✅ Security
  • ✅ Documentation
  • ✅ Code review by maintainers
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Release notes snippet
  • ✅ Release canvas_override-1.0.0-alpha2

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

  • feat: #3583263 Add MkDocs configuration to enable GitLab Pages documentation build

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed 5d57724e on 1.0.x
    feat: #3583263 Add MkDocs configuration to enable GitLab Pages...

  • rajab natshah committed c0a4d2fc on 1.0.x
    feat: #3583263 Add MkDocs configuration to enable GitLab Pages...
rajab natshah’s picture

Assigned: rajab natshah » josebc
Issue summary: View changes
Status: Active » Needs review
Issue tags: +canvas_override-1.0.0-alpha2
rajab natshah’s picture

Assigned: josebc » Unassigned
Status: Needs review » Fixed

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.

rajab natshah’s picture

Issue summary: View changes

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.