Skip to content

Refactor Plan

Goal

Convert the Day-based Embedded Linux learning repo into a searchable MkDocs Material documentation site while preserving the original lab code and learning history.

Phase 1: MkDocs Scaffold

  • Add mkdocs.yml.
  • Add requirements.txt.
  • Add website entry pages:
  • docs/index.md
  • docs/roadmap.md
  • docs/topics/index.md
  • docs/labs/index.md
  • docs/api-reference/index.md
  • Copy learning-log/ into docs/logs/ for MkDocs navigation.
  • Keep existing docs/notes/ and docs/labs/ intact.

Phase 2: Topic Mapping

  • Group existing notes under topic index pages.
  • Do not duplicate full content yet.
  • Link original notes and labs from topic pages.

Phase 3: Lab Normalization

  • Standardize lab folder naming.
  • Rename each lab markdown to README.md when ready.
  • Move source code into src/ only when it improves readability.
  • Move scripts into scripts/ only when it improves readability.

Phase 4: API Reference Extraction

  • Extract repeated API explanations into focused API reference pages.
  • Keep labs practical and topics conceptual.

Phase 5: Cloudflare Pages Deployment

  • Configure Cloudflare Pages:
  • Build command: mkdocs build
  • Output directory: site
  • Python dependencies: requirements.txt