AI-generated documentation for my site
I asked AI to generate documentation for my site’s codebase. Here’s the output.
I ran this before and after I started development. The original is here.
Website Documentation - Ed Marsh Portfolio
Overview
This is a static website built with Eleventy (11ty) that serves as a portfolio and blog for Ed Marsh, a technical writer with over 30 years of experience. The site replaces a legacy WordPress implementation with a modern static site architecture.
Technology Stack
- Static Site Generator: Eleventy (11ty)
- Template Language: Nunjucks
- CSS Framework: Tailwind CSS
- Content Format: Markdown with YAML frontmatter
- Build Tools: Node.js
Content Structure
Primary Content Types
-
Homepage (
index.njk
)- Introduction section with bio
- Featured skills gallery
- Recent static site transformation posts
- Recent podcast episodes
-
Grid Pages
- Display collections of related content
- Used for skills, blog posts, and podcast episodes
- Implemented via
layouts/grid.njk
-
Detail Pages
- Individual content pages
- Used for podcast episodes and blog posts
- Implemented via
layouts/details.njk
Content Collections
Content is organized into several main collections:
skills
- Professional capabilities and servicesssg
- Blog posts about static site transformationpodcasts
- Content Content podcast episodes
Featured Content System
Featured content is controlled through frontmatter metadata:
---
featured: true
featuredOrder: 0 # Lower numbers appear first
---
Example implementation in templates:
Content Architecture
Content files are organized in the following structure:
content/
├── skills/ # Professional capabilities
├── podcasts/ # Podcast episodes
├── static-site-transformation/ # SSG blog series
Build Process
- Start the Tailwind CSS processor:
npx tailwindcss --watch -o _includes/css/tw.css
- Run Eleventy development server:
npx @11ty/eleventy --serve
The site will be available at localhost:8080