[wei]

Adds public/llms.txt (served at https://socialify.dev/llms.txt) following the llmstxt.org format: how to build image URLs, the /image vs /png vs /svg endpoints, every query parameter with valid values and defaults, examples for README and og:image, error behavior, and the GitHub social preview upload flow.

Parameters were checked against common/types/configType.ts and common/configHelper.ts, and spot-checked on the live site.

AGENTS.md now lists the route and notes that llms.txt must be updated when parameters, fonts, patterns, or themes change.

Summary by CodeRabbit

• Documentation
  • Added /llms.txt, a guide to generating Socialify repository preview images, including URL options, examples, and usage notes.
  • Documented when the guide should be updated as image options change.

[changeset-bot]

🦋 Changeset detected

Latest commit: c6735ea

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
socialify	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[netlify]

✅ Deploy Preview for github-socialify ready!

Name	Link
🔨 Latest commit	c6735ea
🔍 Latest deploy log	https://app.netlify.com/projects/github-socialify/deploys/6ae153d6bd32e00b43a9775d
😎 Deploy Preview	https://deploy-preview-898--github-socialify.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: aa88f902-7db3-4d87-852c-780765c8a1fa

Commits

Reviewing files that changed from the base of the PR and between d0139df and c6735ea.

Files selected for processing: 3

• .changeset/add-llms-txt.md
• AGENTS.md
• public/llms.txt

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

Walkthrough

Adds public/llms.txt with instructions for constructing Socialify image URLs, supported options, examples, and response details. The API Routes documentation identifies the static guide, and a changeset marks the addition for a patch release.

Changes: Socialify image URL guide

Layer / File(s)	Summary
Document and publish the usage guide public/llms.txt, AGENTS.md, .changeset/add-llms-txt.md	The guide documents URL formats, options, examples, and error responses. AGENTS.md lists GET /llms.txt and identifies the guide’s location. The changeset marks a patch release.

Priority: Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: Minimal · up to c6735

The documentation-only change is ready to merge with no identified user or production risk.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: adding llms.txt with usage instructions for LLMs.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

• X
• Mastodon
• Reddit
• LinkedIn

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