1
0

Add project documentation files

- Add README.md with comprehensive project overview and setup instructions
- Add AGENTS.md with build commands and code style guidelines for development agents
This commit is contained in:
2025-12-25 12:13:28 -05:00
parent 9a313c53a8
commit 874156bb0d
2 changed files with 165 additions and 0 deletions

39
AGENTS.md Normal file
View File

@@ -0,0 +1,39 @@
# Taylors.Life Development Guide
This is a Hugo static site for family content and blog posts.
## Build Commands
- `hugo` - Build the site
- `make build` - Build using makefile
- `make publish` - Build and deploy site
## Testing
No formal test suite. Verify build outputs locally before deployment.
## Code Style Guidelines
### Front Matter (Markdown)
- Use YAML front matter with title, date, draft, tags, author
- Include featuredImage path when using images
- File names: YYYY-MM-DD.md for dated posts, kebab-case otherwise
- Use typora-root-url: ../../static for local image previews
### Content Structure
- Store images in /static/img/[post-name]/
- Use relative image paths in content: /img/[post-name]/image.jpg
- Include alt text for all images
- Use HTML5 semantic elements where appropriate
### Shortcodes
- Video: `{< video width="640" height="360" src="/path/to/video.mp4" >}`
- Instagram: `{< instagram >}` for embeds
### Naming Conventions
- Post directories: kebab-case matching post title
- Image files: descriptive names, no spaces
- Tags: lowercase, space-separated in brackets
### Git Workflow
- Draft posts: draft: true in front matter
- Only commit when explicitly requested
- Use descriptive commit messages