Skip to content

Add comprehensive AI assistant guide (CLAUDE.md)#1

Open
avinashahuja wants to merge 1 commit into
mainfrom
claude/claude-md-mi4c91wkje2o5iai-016xY8NGv4SS62rZsbzdPi3K
Open

Add comprehensive AI assistant guide (CLAUDE.md)#1
avinashahuja wants to merge 1 commit into
mainfrom
claude/claude-md-mi4c91wkje2o5iai-016xY8NGv4SS62rZsbzdPi3K

Conversation

@avinashahuja

Copy link
Copy Markdown
Owner

Summary

This PR adds a comprehensive guide document (CLAUDE.md) to help AI assistants understand and work effectively with the avinashahuja.github.io codebase. The document serves as a reference for project structure, conventions, workflows, and best practices.

Key Changes

  • New file: CLAUDE.md - A 339-line comprehensive guide covering:
    • Project overview and purpose (Jekyll-based personal blog using Chirpy theme)
    • Complete repository structure with descriptions of key directories and files
    • Technology stack and dependencies (Jekyll 4.x, Ruby 2.7+, Chirpy theme)
    • Detailed configuration reference for _config.yml and site settings
    • Content creation guidelines with examples for blog posts and tab pages
    • Development workflow including local setup, Git workflow, and CI/CD process
    • Coding conventions for file naming, YAML, Markdown, and front matter
    • Theme customization guidance
    • Common tasks with step-by-step instructions
    • DO/DON'T guidelines for AI assistants
    • Testing checklist before pushing changes
    • Links to relevant documentation and resources

Notable Implementation Details

  • Includes concrete examples of required front matter for posts and tabs
  • Provides specific naming conventions (e.g., YYYY-MM-DD-title-with-hyphens.md)
  • Documents the GitHub Actions deployment workflow and trigger conditions
  • Clarifies important considerations like permalink preservation, timezone consistency, and SEO implications
  • Establishes clear boundaries on what should and shouldn't be modified
  • Includes a maintenance section with version information for future reference

https://claude.ai/code/session_016xY8NGv4SS62rZsbzdPi3K

- Document repository structure and key directories
- Explain Jekyll + Chirpy theme configuration
- Define content creation guidelines for posts and tabs
- Outline development workflow and deployment process
- Specify coding conventions and best practices
- Include troubleshooting and testing checklists
- Add helpful resources and maintenance notes
@netlify

netlify Bot commented Apr 7, 2026

Copy link
Copy Markdown

Deploy Preview for naughty-keller-187210 failed.

Name Link
🔨 Latest commit 6169cda
🔍 Latest deploy log https://app.netlify.com/projects/naughty-keller-187210/deploys/69d58d4dc36ae3000829addf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants