AI assistants and tooling data

The AI guide

llms-full.txt is the complete guide for AI assistants. It covers the syntax rules, every mixin, the token system, configuration, compile-time errors and an anti-hallucination table, so an assistant writes correct WovenUI code. It matches the installed core version. When the guide and the SCSS in core/src/styles disagree, the source wins.

File	URL	Contents
llms-full.txt	wovenui.com/llms-full.txt	The full guide
llms.txt	wovenui.com/llms.txt	A short index: what WovenUI is, install and configure steps, the rules that are easy to get wrong, then a link and description for every docs page (grouped like the sidebar), the playground, the guides and the comparison pages

Use it in a project

The npm package ships the guide, so with @wovenui/core installed there is nothing to download:

1. Add a line to the project’s assistant instruction file that points at the installed copy, such as: For WovenUI code, follow node_modules/@wovenui/core/docs/llms-full.txt.
2. Upgrade core as usual. The guide stays in step with the installed version.

The same docs folder also holds TOKENS.md (every token with its light and dark value) and DOC-BLOCKS.md (the doc block standard for core’s SCSS).

For a project without the package installed, or to paste into a chat, use the site copy at wovenui.com/llms-full.txt. Paste only the section the assistant needs, such as “The Law: Syntax Rules” or “Complete Mixin Reference”.

SassDoc data

@wovenui/core/sassdoc.json (dist/sassdoc.json in the package) holds the SassDoc data of every documented mixin, function and variable, for editor tooling. The current build has 426 items: 342 mixins, 19 functions and 65 variables.

The file is a JSON array, one object per item, sorted by file and line. Fields:

Field	Meaning
context	type (mixin, function or variable), name, the source code and its line range
description	The doc text
parameter	Mixins and functions with arguments: name, type, description and, when set, default
example	Objects with type and code
group	Group names, such as spacing
groupDescriptions	The text of each group named in group
file	path relative to src/styles, and name
access	public
return, throw, output, content, see, link, usedBy, require, type	Present when the item has them

One item, the p mixin, trimmed to the fields above (code, groupDescriptions, see and link omitted):

{
  "description": "Sets padding on all sides from a spacing key or a raw value.\n",
  "context": { "type": "mixin", "name": "p", "line": { "start": 142, "end": 144 } },
  "parameter": [
    {
      "type": "Number|Length|Calculation|String",
      "name": "val",
      "description": "Spacing key (4 gives var(--wu-space-4)), or a value with a unit, calc() or var(); negative keys and auto raise an error"
    }
  ],
  "example": [
    { "type": "scss", "code": ".card {\n  @include p(4); // padding: var(--wu-space-4)\n}" }
  ],
  "group": ["spacing"],
  "access": "public",
  "file": { "path": "utilities/_spacing.scss", "name": "_spacing.scss" }
}

Core doc comments follow the SassDoc standard (core/docs/DOC-BLOCKS.md), so the data regenerates on every core build. The reference pages on this site are built from the same doc blocks.

For installing core and the other package entries, see Installation.