Skip to content

v0.2.0 MKDOC Buildout

Latest

Choose a tag to compare

@G-Schumacher44 G-Schumacher44 released this 11 Aug 16:17
· 5 commits to main since this release

v0.2.0 – Site Public Release

Core Setup

  • Adopted MkDocs with the Material theme for a modern, responsive documentation site.
  • Created a full docs/ site structure with section hubs for Python, SQL, and Workflow & Projects.
  • Implemented a custom landing page (docs/index.md) featuring a hero section and quick-access action buttons.

Branding & Navigation

  • Applied initial branding with logo, site title, and tagline.
  • Streamlined navigation hierarchy and filenames for clean, user-friendly URLs.
  • Wired up navigation and metadata in mkdocs.yml, preparing for GitHub Pages deployment (local mkdocs serve ready).

Content Organization

  • Added QuickRef, Guidebooks, and Scripts sections under Python for easy reference.
  • Consolidated BigQuery and Looker Studio content under SQL, including best practices and dashboard guides.
  • Built a Workflow Hub with scaffolds, checklists, and delivery templates to support project execution.

Enhancements

  • Homepage Layout – Updated .home-grid to display two cards per row for better readability and balance on desktop.
  • Card Styling – Normalized heights with flexbox, clamped text blurbs to 2 lines, and anchored link buttons to the bottom for consistent alignment.
  • Button Styling – Reduced border-radius from pill shape to 6px and tightened padding/font size for a cleaner look.
  • Hero Actions Grid – Maintains responsive design with improved alignment across breakpoints.

Navigation Improvements

  • Added Home button to the top bar next to the light/dark mode toggle, pointing directly to the site’s root (docs/index.md).
  • Fixed broken “Overview” link path in the Python QuickRef > Reference Guides section.
  • Corrected folder name mismatches in mkdocs.yml to prevent 404 errors.