Skip to content

Fix navigation structure and update learning path flow#1

Merged
mtahle merged 1 commit into
mainfrom
claude/fix-documentation-linking-X6ECF
May 13, 2026
Merged

Fix navigation structure and update learning path flow#1
mtahle merged 1 commit into
mainfrom
claude/fix-documentation-linking-X6ECF

Conversation

@mtahle
Copy link
Copy Markdown
Owner

@mtahle mtahle commented May 13, 2026

Summary

This PR restructures the documentation navigation hierarchy for consistency and improves the learning path flow by updating the entry point and cross-references throughout the documentation.

Key Changes

Navigation Structure:

  • Fixed indentation inconsistency in mkdocs.yml — all subsections now use consistent 6-space indentation under their parent categories
  • Removed duplicate/orphaned entries from Foundations section (CALMS, DevOps Practices, History)
  • Added descriptive label "Foundations Overview" to the introduction index page

Learning Path Updates:

  • Changed main entry point from concepts/internet-basics.md to introduction/index.md in the homepage CTA button
  • Updated concepts/index.md to include a call-to-action button linking to Internet Basics
  • Modified introduction/culture.md to link forward to Network & Web Fundamentals instead of looping back to index
  • Updated linux/troubleshooting-tools.md to link to Container Networking with proper relative path

Documentation Flow:

  • Improved progression through the learning roadmap by establishing clearer forward navigation
  • Ensured all cross-references use correct relative paths

Implementation Details

  • All changes maintain backward compatibility with existing content
  • Navigation hierarchy now properly reflects the intended learning sequence: Foundations → Network & Web → Linux → Containers → Automation → Monitoring → Advanced
  • Button styling and markdown formatting preserved throughout

https://claude.ai/code/session_01EtjTL2H1tuHh2gVegvRqG4

- Remove duplicate foundations/ stub pages from nav (calms, history,
  devops-practices) that shadowed the complete introduction/ pages
- Add missing label for introduction/index.md in nav
- Standardize nav child indentation to 4 spaces across all sections
- Fix dead-end link in introduction/culture.md: forward to concepts/index.md
  instead of looping back to the section index
- Fix home page Get Started button to begin at introduction/index.md
  so the Foundations section is not skipped
- Add Get Started CTA to concepts/index.md pointing to internet-basics.md
- Replace unlinked "Container Networking concepts" in troubleshooting-tools.md
  with a proper link to containers/introduction.md
- Replace plain-text Next Steps in monitoring/introduction.md with a link
  to advanced/index.md
@mtahle mtahle merged commit e6954a5 into main May 13, 2026
1 of 2 checks passed
@mtahle mtahle deleted the claude/fix-documentation-linking-X6ECF branch May 13, 2026 01:14
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.

2 participants