Lab Notebook Documentation Index

Welcome to The Lab Notebook documentation! This comprehensive guide covers everything you need to know about using, developing, and contributing to the project.

Getting Started

• Getting Started Guide - Installation, setup, and first steps
• Development Guide - Development workflow, coding standards, and best practices

Component Documentation

• FeatureCard Component - Interactive project showcase cards
• LightboxImage Component - Images with lightbox functionality
• PhotoGrid Component - Responsive image grids
• InfoCard Component - Informational cards
• QuickLinkCard Component - Quick access link cards
• SectionTitle Component - Section header titles
• ListLinks Component - Lists of links
• LandingHeader Component - Header for landing pages
• ProjectCardSmall Component - Compact project cards
• ProjectCardLarge Component - Large project cards
• UpdateCard Component - Cards for updates and news
• ProjectDomainTabs Component - Domain-based project filtering
• StatusLink Component - Status-based navigation links
• Analytics Component - Umami analytics integration

Script Documentation

• Create Placeholders Script - Generate SVG placeholder images
• Verify Links Script - Check internal links and assets
• Verify Projects Script - Validate project data structure and integrity
• Verify Meta Script - Ensure MDX files are listed in navigation (_meta.js files)

Utility Documentation

• Meta Utils - Metadata processing utilities
• Project Directory Structure - Project organization guidelines

Quick Reference

Essential Commands

npm run dev              # Start development server
npm run build            # Build for production
npm run check            # Run comprehensive validation (lint, links, projects, meta)
npm run verify-links     # Check internal links and assets
npm run verify-projects  # Validate project data structure
npm run verify-meta      # Check navigation structure integrity

Project Structure

content/project/the-lab-notebook/
├── docs/
│   ├── guides/          # Getting started and development guides
│   ├── components/      # Component documentation
│   ├── scripts/         # Build script documentation
│   └── utilities/       # Utility function documentation
└── documentation-index.mdx  # This file

Contributing

1. Read the Development Guide
2. Check existing documentation for similar examples
3. Run npm run check before committing
4. Follow the established documentation patterns

For questions or updates, please refer to the relevant documentation section or consult the development guide.