Skip to content

Add AGENTS.md guide for agentic software development#159

Merged
diamantidis merged 2 commits intosourcefrom
add-agents-md
Apr 13, 2026
Merged

Add AGENTS.md guide for agentic software development#159
diamantidis merged 2 commits intosourcefrom
add-agents-md

Conversation

@diamantidis
Copy link
Copy Markdown
Owner

Plan

  • Add an AGENTS.md file to guide agentic software development tools (like opencode, Cursor, etc.) on how to work with this Jekyll blog
  • Adapted from a template used in another Jekyll project, tailored to this project's specific setup:
    • No separate CSS watcher (Tailwind runs via jekyll-postcss plugin)
    • GitHub Pages deployment (sourcemaster branching)
    • Single language (English)
    • minima theme + SCSS + Tailwind via @apply directives
    • Danger + proselint CI
    • Tips collection
  • Includes sections: Project Overview, Structure, Key Features, How to Run, Tailwind CSS Setup, Playwright Verification, Git Workflow, Best Practices

Tests

  • Manual verification: Home page loads correctly
  • Playwright smoke test: PASS
    • Home page navigation works with 7 paginated posts
    • Blog post page loads with title, content, code blocks, and metadata
    • Static pages (About, Archive) render correctly
    • Navigation links (Tips, About, Archive, Tags) functional
  • Visual verification: Site renders correctly with styles

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 13, 2026

Proselint found issues

AGENTS.md

Line Message Severity
215 'off' is the preferred form. warning

Spell Checker found issues

AGENTS.md

Line Typo
1 # AGENTS.md - Guide for Agentic Software
1 # AGENTS.md - Guide for Agentic Software Development
5 Ioannis Diamantidis's personal blog —
5 Ioannis Diamantidis's personal blog — a software de
5 tic site generator) using the minima theme and styled with a combi
7 Technology Stack*: Jekyll + minima theme + Tailwind CSS (via jek
7 ima theme + Tailwind CSS (via jekyll-postcss) + Ruby + Node.js
7 (via jekyll-postcss) + Ruby + Node.js
69 - Analytics: TelemetryDeck and PostHog
69 - Analytics: TelemetryDeck and PostHog (production envir
69 nalytics**: TelemetryDeck and PostHog (production environment only)
70 tHub Actions CI with Danger + proselint for prose linting on PRs
71 - SEO: jekyll-sitemap, jekyll-feed, and jekyll-seo-
71 - SEO: jekyll-sitemap, jekyll-feed, and jekyll-seo-tag
71 yll-sitemap, jekyll-feed, and jekyll-seo-tag
81 - Node.js 22.2.0
155 - How it works: PostCSS processes CSS files during Je
156 - Config: postcss.config.js loads
156 oads Tailwind CSS and applies cssnano in production (`JEKYLL_ENV=pr
177 aded with title, content, and metadata
207 ## Git Workflow with gh-cli
285 ### Useful gh-cli Commands
304 ded** — Tailwind runs through jekyll-postcss automatically

Generated by 🚫 Danger

@diamantidis diamantidis merged commit b5c7b5d into source Apr 13, 2026
2 checks passed
@diamantidis diamantidis deleted the add-agents-md branch April 13, 2026 21:22
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.

1 participant