Skip to content

llms.txt

SyncupSuite publishes machine-readable project summaries so LLMs can understand the platform without scraping docs pages.

What llms.txt Is

A plain-text file at a known URL that describes a project's architecture, conventions, and entry points. The spec lives at llmstxt.org. Think of it as robots.txt for AI -- instead of telling crawlers what to avoid, it tells LLMs what to read first.

Our Two Files

We publish two versions:

FileURLSizePurpose
llms.txtsyncupsuite.com/llms.txt~30 linesQuick summary -- install commands, key links, what the platform is
llms-full.txtsyncupsuite.com/llms-full.txt~275 linesFull reference -- every npm package, every theme, stack details, architecture

What's in the Short Version

The short version is what an LLM reads first. Here it is in full:

markdown
# SyncupSuite

> Build culturally-intelligent SaaS products faster.

SyncupSuite is a platform providing:
- **Claude Code marketplace plugin** (`webplatform4sync`) — skills for multi-tenant
  architecture, graduated auth, Neon/Drizzle patterns, and culturally-grounded
  design tokens
- **@syncupsuite/themes** — 12 design token packages (DTCG JSON, CSS, Tailwind v4)
  grounded in cultural traditions: swiss-international, nihon-traditional,
  nordic-modern, tang-imperial, shuimo-modern, nihon-minimal, renaissance,
  art-deco, wiener-werkstaette, milanese-design, de-stijl, swiss-modernist
- **BrandSyncUp** — enterprise brand collaboration platform
- **LegalSyncUp** — Swiss legal compliance platform

## Install the Marketplace Plugin

claude mcp add https://raw.githubusercontent.com/syncupsuite/webplatform4sync/main/.claude-plugin/manifest.json

## Install Design Tokens

npm install @syncupsuite/themes

## Key Links

- Full documentation for LLMs: https://syncupsuite.com/llms-full.txt
- Marketplace: https://github.com/syncupsuite/webplatform4sync
- Themes: https://github.com/syncupsuite/themes
- npm: https://www.npmjs.com/org/syncupsuite
- Developer docs: https://docs.syncupsuite.com
- GitHub org: https://github.com/syncupsuite

What's in the Full Version

llms-full.txt expands every section the short version summarizes:

SectionWhat it covers
ProductsBrandSyncUp and LegalSyncUp -- domain, stack, status
npm PackagesAll 4 packages with install commands, exports, and usage examples
Theme DetailsAll 12 themes with slugs, descriptions, subpath exports, semantic color API
Marketplace Plugin4 skills, 2 command frames, activation commands
Architecture3-tier model, auth graduation, tech stack table
Key URLsEvery relevant link in one place

An LLM reading the full version has enough context to install the packages, import a theme, use the semantic token API, and understand the multi-tenant tier model -- without browsing any web pages.

How LLMs Consume It

Claude Code reads llms.txt automatically when you point it at a URL. Other LLMs can fetch it directly:

# In a Claude Code session
/fetch https://syncupsuite.com/llms.txt

The file is static, cacheable, and served from Cloudflare's edge. No authentication required.

The marketplace plugin also generates per-project llms.txt files when you scaffold a new project:

/webplatform4sync:shu tune

This creates an llms.txt in your repo root that reflects your project's active tiers, theme selection, and stack.

Adding llms.txt to Your Own Project

Three steps:

  1. Create public/llms.txt (or at your site root) with a Markdown summary of your project
  2. Include install commands, key architecture decisions, and links to deeper docs
  3. Optionally create llms-full.txt with the complete reference

Keep it plain Markdown. No frontmatter, no YAML, no HTML. LLMs parse Markdown natively -- anything else adds friction.

TIP

Start with 15-20 lines covering what the project is, how to install it, and where to find more. You can always expand later.

Next Steps

Released under the MIT License.