Skip to content

docs: add agent instructions - #9

Merged
nathanialhenniges merged 1 commit into
mainfrom
codex/add-agents-instructions
Jul 23, 2026
Merged

nathanialhenniges merged 1 commit into
mainfrom
codex/add-agents-instructions

Conversation

@nathanialhenniges

@nathanialhenniges nathanialhenniges commented Jul 23, 2026

Copy link
Copy Markdown
Member

Summary

  • add an AGENTS.md guide for coding agents
  • mirror the current project architecture and development commands from CLAUDE.md
  • document the shared formula/cask detail-page implementation

Summary by CodeRabbit

  • Documentation
    • Added repository documentation covering the Homebrew tap, hosted packages, documentation site structure, build process, and testing workflow.
    • Included common development commands and Homebrew usage examples.

@nathanialhenniges
nathanialhenniges merged commit 54c6484 into main Jul 23, 2026
2 of 3 checks passed
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: dd88ff3e-f843-4d0e-bafd-070f195bd577

📥 Commits

Reviewing files that changed from the base of the PR and between 1335e32 and d81d7ad.

📒 Files selected for processing (1)
  • AGENTS.md

Walkthrough

Added AGENTS.md documenting the repository structure, documentation-site architecture, local build and test workflows, CI behavior, and common Homebrew commands.

Changes

Repository Guidance

Layer / File(s) Summary
Repository structure and site architecture
AGENTS.md
Documents the Homebrew tap layout, contribution conventions, generated documentation-site structure, rendering, styling, navigation, and package metadata features.
Build, test, and usage workflow
AGENTS.md
Documents local builds, GitHub Releases checks, testing with Vitest and cheerio, CI triggers, and common Homebrew and Node commands.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

A rabbit reads the tap by moonlit glow,
Finds build commands neatly in a row.
Pages bloom, tests hop in line,
CI checks each release sign.
“AGENTS.md!” the bunny sings,
With docs on all the useful things.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/add-agents-instructions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nathanialhenniges
nathanialhenniges deleted the codex/add-agents-instructions branch July 29, 2026 15:51
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