Entropy Exchange — AI Agent Guidelines

Creating a New Post

just post my-post-slug    # Creates posts/my-post-slug/index.qmd with draft frontmatter

Then edit the generated file. Preview with just preview.

Frontmatter Requirements

Every post must have:

---
title: "Descriptive Title"
author: "Author Name"
date: "YYYY-MM-DD"
categories: []
draft: true
---

Category Conventions

  • General topics: [ai, llm, ocr, data-engineering, mlops] etc.
  • Internal playbooks: include playbook in categories, e.g. [playbook, databricks]
  • Posts with playbook category appear on the playbooks index page

Content Guidelines

  • Write for a technical audience familiar with ML/AI and data engineering
  • Don’t include passwords, API keys, internal URLs, or customer-specific details
  • Use relative paths for images stored in the post directory
  • Prefer .qmd for text-heavy content, .ipynb for code-heavy/notebook content

Working with Notebooks

  • Databricks metadata is auto-cleaned by filters/filter.py
  • Each notebook post can have its own pyproject.toml for dependencies
  • The root pyproject.toml only covers site-build dependencies

Things to Avoid

  • Don’t add dependencies to the root pyproject.toml (post deps go in post dirs)
  • Don’t modify Lua filters without running just render to verify
  • Don’t commit large binary files (images > 1MB, datasets, model weights)
  • Don’t change posts/_metadata.yml freeze settings without good reason
  • Don’t remove draft: true without explicit approval

Verification Checklist

Before considering work complete:

  1. just lint — pre-commit hooks pass
  2. just preview — site renders locally, new content appears
  3. just render-public — public build succeeds (drafts excluded)
  4. just render-internal — internal build succeeds (all content included)