Skip to content

Fix docs build failure caused by stale MkDocs theme override path#74

Merged
ekizito96 merged 2 commits into
mainfrom
copilot/fix-github-actions-build-failure
May 18, 2026
Merged

Fix docs build failure caused by stale MkDocs theme override path#74
ekizito96 merged 2 commits into
mainfrom
copilot/fix-github-actions-build-failure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 18, 2026

The GitHub Actions build job for documentation was failing during mkdocs build because the site configuration referenced a theme override directory that no longer exists in the repository. This updates the docs config to match the current repository layout.

  • Root cause

    • mkdocs.yml set theme.custom_dir to docs/overrides
    • docs/overrides is not present, causing MkDocs to abort with a configuration error
  • Change

    • Removed the stale custom_dir entry from the Material theme configuration
    • Left the rest of the theme setup unchanged
  • Impact

    • Restores successful documentation site builds in GitHub Actions
    • Avoids introducing placeholder directories or unused override scaffolding
theme:
  name: material
  logo: assets/nexus-logo-blue.png
  favicon: assets/nexus-logo-blue.png

Agent-Logs-Url: https://github.com/Prescott-Data/nexus-framework/sessions/0ae80456-39aa-4037-9720-71f158a2e655

Co-authored-by: ekizito96 <87319861+ekizito96@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix failing GitHub Actions job "build" Fix docs build failure caused by stale MkDocs theme override path May 18, 2026
Copilot AI requested a review from ekizito96 May 18, 2026 11:48
@ekizito96 ekizito96 marked this pull request as ready for review May 18, 2026 11:57
Copilot AI review requested due to automatic review settings May 18, 2026 11:57
@ekizito96 ekizito96 merged commit cbd3730 into main May 18, 2026
10 checks passed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes a stale MkDocs Material theme override configuration that referenced a non-existent directory, which was causing mkdocs build (and the GitHub Actions docs build) to fail.

Changes:

  • Removed theme.custom_dir: docs/overrides from mkdocs.yml to eliminate the invalid path reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ekizito96 ekizito96 deleted the copilot/fix-github-actions-build-failure branch May 18, 2026 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants