Skip to content

Fix MkDocs workflow errors and update custom home page template#789

Merged
tungbq merged 3 commits into
mainfrom
fix/home-template-and-cname
Jul 5, 2026
Merged

Fix MkDocs workflow errors and update custom home page template#789
tungbq merged 3 commits into
mainfrom
fix/home-template-and-cname

Conversation

@tungbq

@tungbq tungbq commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Fix MkDocs workflow errors and update custom home page template

tungbq and others added 3 commits July 5, 2026 18:31
Three errors from the deploy workflow:

1. docs_dir: . → docs_dir: docs
   MkDocs no longer allows docs_dir to be the parent directory of
   mkdocs.yml. Changed to docs/ subdirectory.

2. site_dir conflict
   site/ was inside docs_dir (root). Now that docs_dir is docs/, site/
   sits at the repo root and is no longer nested inside it.

3. tags_file deprecated → removed
   Replaced `tags_file: tags.md` with bare `- tags` plugin entry, and
   removed the Tags nav entry that depended on it.

Also added a workflow step that symlinks repo-root content trees
(topics/, getting-started/, projects/, troubleshooting/, CONTRIBUTING.md,
ROADMAP.md) into docs/ before the build so MkDocs can resolve all nav
paths without moving any files.

Updated extra_css/extra_javascript paths from docs/stylesheets/ and
docs/javascripts/ to stylesheets/ and javascripts/ (now relative to
docs_dir).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
Move hero content from {% block content %} into {% block tabs %} (after
super()) — the correct pattern for Material 9.x custom home pages.
Content block was silently ignored because Material renders sidebars
outside the content block, resulting in the stock article view.

Also add docs/CNAME so the custom domain devops-basics.thedevopshub.org
survives mkdocs gh-deploy --force --clean which wipes the gh-pages branch.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145wKykex72kkJtrFNarz9M
@tungbq
tungbq merged commit 0f8741a into main Jul 5, 2026
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.

1 participant