|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +This is a Hugo-based static website for FINI (Flamingo Internet Navigators) consulting services. The site is built from converted TWiki content using Hugo with the PaperMod theme and deployed via GitHub Pages. |
| 8 | + |
| 9 | +## Commands |
| 10 | + |
| 11 | +### Essential Development Commands |
| 12 | + |
| 13 | +- `just justsync` - Sync justfiles from www-chicks-net (run this first to get all commands) |
| 14 | +- `just server` - Run Hugo development server locally |
| 15 | +- `just see-server` - Open browser to Hugo site and start server |
| 16 | +- `just hugo` - Build the site (production build) |
| 17 | + |
| 18 | +### Content Development |
| 19 | + |
| 20 | +- `just post <branchname>` - Create a new blog post with timestamp |
| 21 | +- `just branch <branchname>` - Start a new feature branch with timestamp |
| 22 | + |
| 23 | +### Pull Request Workflow |
| 24 | + |
| 25 | +- `just pr` - Create PR with automated checks and watch for completion |
| 26 | +- `just prweb` - View current PR in web browser |
| 27 | +- `just merge` - Merge PR and return to main branch |
| 28 | +- `just sync` - Return to main branch and pull latest changes |
| 29 | + |
| 30 | +### Legacy TWiki Conversion |
| 31 | + |
| 32 | +- `just twiki2hugo` - Convert TWiki .txt files to Hugo Markdown |
| 33 | +- `just fix_twiki_headers` - Convert TWiki headers to Hugo frontmatter |
| 34 | + |
| 35 | +### Linting |
| 36 | + |
| 37 | +- `markdownlint-cli2 **/*.md` - Lint markdown files (configured in .markdownlint.yml) |
| 38 | + |
| 39 | +## Site Architecture |
| 40 | + |
| 41 | +### Content Structure |
| 42 | + |
| 43 | +- `content/EdgeReports/` - Blog posts and company reports |
| 44 | +- `content/FiniServices/` - Service descriptions and offerings |
| 45 | +- `content/Archive/` - Legacy content from TWiki conversion |
| 46 | +- `content/TermsAndConditions/` - Legal documents |
| 47 | + |
| 48 | +### Hugo Configuration |
| 49 | + |
| 50 | +- `hugo.toml` - Main Hugo configuration with PaperMod theme |
| 51 | +- Theme uses profile mode with custom branding for FINI |
| 52 | +- Excludes .txt files (legacy TWiki format) |
| 53 | +- Configured for GitHub Pages deployment |
| 54 | + |
| 55 | +### Development Process |
| 56 | + |
| 57 | +1. All work happens on feature branches created with `just branch <name>` |
| 58 | +2. PRs are created with `just pr` which builds the site and creates automated PR |
| 59 | +3. GitHub Actions run markdownlint, actionlint, and Checkov security scans |
| 60 | +4. Site deploys automatically to GitHub Pages on merge to main |
| 61 | + |
| 62 | +### Key Files |
| 63 | + |
| 64 | +- `justfile` - Local commands that import from www-chicks-net |
| 65 | +- `.just/cache/` - Downloaded justfiles with full command suite |
| 66 | +- `public/` - Generated Hugo site output |
| 67 | +- `.markdownlint.yml` - Markdown linting configuration |
| 68 | +- `.github/workflows/` - CI/CD pipeline definitions |
| 69 | + |
| 70 | +## Content Guidelines |
| 71 | + |
| 72 | +- Use Hugo frontmatter format (TOML) for metadata |
| 73 | +- Images stored in `static/` directory |
| 74 | +- Follow existing content structure patterns |
| 75 | +- Legacy .txt files are ignored in builds but preserved for reference |
0 commit comments