Skip to content

docs: collapse folder+index.md guides to flat single-file guides#25504

Open
brandonh6k wants to merge 1 commit into
docker:mainfrom
brandonh6k:docs/collapse-guide-page-bundles
Open

docs: collapse folder+index.md guides to flat single-file guides#25504
brandonh6k wants to merge 1 commit into
docker:mainfrom
brandonh6k:docs/collapse-guide-page-bundles

Conversation

@brandonh6k

Copy link
Copy Markdown
Contributor

Description

Follow-up to #25338 (the guides revamp). That PR collapsed most multi-page guide series into single pages but left ~50 guides wrapped in a <name>/index.md directory structure alongside guides that are already flat <name>.md files — an inconsistent mix. This PR finishes the flattening:

  • Flattens 50 folder-wrapped guides to content/guides/<slug>.md via git mv (history preserved). These keep the same URL, since Hugo generates the same permalink for a leaf-bundle dir/index.md and a flat dir.md.
  • Moves the last 4 guides' local per-guide image bundles (genai-leveraging-rag, genai-video-bot, genai-claude-code-mcp, java) into the shared content/guides/images/ folder with slug-prefixed filenames, matching the convention already used by most other guides (databases-1.webp, kafka-1.webp, etc.), and rewrites the in-body image references.
  • Normalizes genai-claude-code-mcp's non-standard filename (claude-code-mcp-guide.md) and capitalized Images/ folder to match convention.
  • Promotes content/guides/frameworks/laravel/index.md to a top-level content/guides/laravel.md, since it was the only guide under frameworks/ and every other language/framework guide is flat.
  • Adds aliases entries for the two URLs that actually changed (/guides/frameworks/laravel/ and /guides/genai-claude-code-mcp/claude-code-mcp-guide/); every other rename preserves its existing URL.

Companion PR establishing this as the documented convention going forward: #25503

Validation

  • hugo --minify build via docker compose run completes with zero warnings/errors (3174 pages, 1524 aliases — unchanged from before this PR).
  • Verified both changed-URL guides render at their new path and the old path 301s via the Hugo alias redirect.
  • Verified every image reference in the 4 migrated guides resolves to an existing file in content/guides/images/.
  • Multi-agent docs review (link-checker, cross-reference-checker, guide-conventions) found zero issues.

Related issues or tickets

Discussed in the team's docs Slack channel following #25338.

Reviews

  • Technical review

Flattens 50 folder-wrapped guides to content/guides/<slug>.md, matching the
single-page convention most guides already use. Also moves the last local
per-guide image bundles (genai-leveraging-rag, genai-video-bot,
genai-claude-code-mcp, java) into the shared content/guides/images/ folder
with slug-prefixed filenames, and promotes frameworks/laravel/index.md to
a top-level laravel.md.

Adds aliases for the two URLs that actually changed (frameworks/laravel/
and genai-claude-code-mcp/claude-code-mcp-guide/); all other renames
produce the same URL Hugo already generated for the index.md bundle.
@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit c7682e3
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a4c28f06018520008570db9
😎 Deploy Preview https://deploy-preview-25504--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant