> For the complete documentation index, see [llms.txt](https://ascribed-dev.com/docs/llms.txt). This documentation describes Ascribe 0.4.4. Anything marked in main, not yet released isn't in that release yet. # Glossary > Reference ยท The terms these docs use, each with a sentence on what it means and a link to the page that documents it. Each term below is linked from the pages that use it, with its first paragraph as the link's title. Most of them are ordinary words too, so they're linked only where a page links them here: acknowledgement, address, agent, build, example, phrase, preview, report, review, source, target, and variant. Each has one meaning in these docs, and where a word is also used another way, its entry says where and what it means there. ## Acknowledgement A note that a problem a check reports is intended, written with `@intended` beside the content or in `ascribe.toml`, so the check doesn't report it again. Only a check whose next step is review can be acknowledged, and each diagnostic's entry says where. See [`@intended`](https://ascribed-dev.com/docs/writing/directives.md#intended). ## Address Where a build publishes a page or its Markdown version, such as `/docs/install/`, which `ascribe.addresses` keeps leading somewhere when the page moves or goes. See [Keep the addresses you've published](https://ascribed-dev.com/docs/publishing/redirects.md). A snippet's address, such as `code:service/client.py#connect`, is another thing: the file and region of a [source](https://ascribed-dev.com/docs/glossary.md#source) that [`@snippet`](https://ascribed-dev.com/docs/writing/directives.md#snippet) shows. ## Agent An AI program, such as Claude Code or GitHub Copilot, that writes a project's docs with Ascribe's tools, or reads the docs a site publishes. Most pages mean the agent you work with on the docs, as [Agents](https://ascribed-dev.com/docs/agents.md) does. The outputs for agents, [`[consumer] agents`](https://ascribed-dev.com/docs/content-model/output.md#15-consumer), and [`ascribe report delivery`](https://ascribed-dev.com/docs/checks/report.md#delivery-to-agents) are about the agents that read the published site, and [`ascribe agents index`](https://ascribed-dev.com/docs/agents/product-index.md) writes for a product's own agents. ## Availability Where content applies and its lifecycle state there, such as `self-managed preview 3.4`, written with `@available` or a page's `available`. See [`@available`](https://ascribed-dev.com/docs/writing/directives.md#available). Each build either marks it or removes what isn't available. ## Baseline The list in `ascribe.baseline` of the advice a project had when it was written, which `ascribe check` holds back so it reports only what's new. See [The baseline](https://ascribed-dev.com/docs/checks/baseline.md). ## Build A named set of choices, in `ascribe.toml`, for which variants and which availability a page's output keeps. Each build is declared in [`[builds.]`](https://ascribed-dev.com/docs/content-model/output.md#16-buildsname). ## Content model A project's schema, `ascribe.toml`: its content types, dimensions, phrases, and builds. [The content model](https://ascribed-dev.com/docs/content-model.md) documents each of its sections. ## Dimension An axis content varies along, such as a package manager or a deployment, declared in `ascribe.toml`. See [`[dimensions]`](https://ascribed-dev.com/docs/content-model/variation.md#11-dimensionsname) and [Content that varies](https://ascribed-dev.com/docs/writing/variants.md). ## Example Code a page shows from a source's file with `@snippet`, so the page has no copy to fall behind, and that `ascribe.examples.toml` can name so a test runs it. See [Examples and drift](https://ascribed-dev.com/docs/examples.md) and [Show what an example was tested with](https://ascribed-dev.com/docs/examples/tested.md). A JSON block marked as an OpenAPI operation's request or response is an API example, which the `api-example-*` checks [compare with its schema](https://ascribed-dev.com/docs/openapi/examples.md), and this repository's `examples/` folder holds example projects; neither is this. ## Fragment A source file that exists only to be included in other files: any file with a path segment starting with `_`, or whose path matches one of the content model's [`[fragments] patterns`](https://ascribed-dev.com/docs/content-model.md#4-typesname-and-fragments). See [Files](https://ascribed-dev.com/docs/writing/frontmatter.md#files) and [`@include`](https://ascribed-dev.com/docs/writing/directives.md#include). ## HTML preview The HTML file `ascribe diff --format html` writes, showing a pull request's changed pages rendered and marked, which CI can attach to the pull request. It's the third place to [review](https://ascribed-dev.com/docs/glossary.md#review), beside the page preview and the site preview, and needs no checkout. See [Attach the HTML preview to every pull request](https://ascribed-dev.com/docs/review/ci-report.md). ## Memo A note for whoever edits a page next, saying why it's written the way it is, kept beside what it's about and never published. It's written with `@memo` in the page, or as a memo file in `memos/`. See [Leave a memo for whoever edits next](https://ascribed-dev.com/docs/writing/memos.md). ## Page preview The editor's preview of the active page, rendered as the site shows it. See [the preview](https://ascribed-dev.com/docs/editor/preview.md). ## Permalink A name for a page or a heading, such as `go/weave-config`, whose address leads to it wherever it moves, for linking to the docs from outside them. See [Permalinks](https://ascribed-dev.com/docs/permalinks.md) and [`@id`'s permalinks](https://ascribed-dev.com/docs/writing/directives.md#permalinks). ## Phrase A reusable string declared in `ascribe.toml` and written `{key}` in a page. See [Phrases](https://ascribed-dev.com/docs/writing/inline.md#phrases). ## Preview Pages shown before they're published. These docs always say which of the four: the page preview, the site preview, the HTML preview, or `ascribe preview`. The [page preview](https://ascribed-dev.com/docs/glossary.md#page-preview) is in the editor; the [site preview](https://ascribed-dev.com/docs/glossary.md#site-preview) is the project's own dev server; the [HTML preview](https://ascribed-dev.com/docs/glossary.md#html-preview) is a pull request's, from `ascribe diff --format html`; and [`ascribe preview`](https://ascribed-dev.com/docs/checks/check.md#ascribe-preview) renders a build as a plain site and serves it on this computer with the command alone. None of them is the published site. ## Recheck date When a page is next due to be read against what it describes: its field with the `recheck-date` role, which [`recheck-overdue`](https://ascribed-dev.com/docs/checks/diagnostics/content-checks.md#asc153-recheck-overdue) compares with today. It was the review date, with the role `review-date` and the check `review-overdue`, and both old names still work for a release. See [Field roles](https://ascribed-dev.com/docs/content-model.md#54-field-roles). ## Release line A version of a target as `[releases]` lists it, such as `3.4`, which holds every version that starts with it: live, planned, or archived. See [Release lines](https://ascribed-dev.com/docs/versions/lines.md). Pages about versions call it a line. Elsewhere a line is a file's line, and a code block's tested line is the line under it that says what it was [tested with](https://ascribed-dev.com/docs/examples/tested.md). ## Report What `ascribe report` says about the state of a whole project: its problems, inventory, builds, pages, external links, and published site. See [The project report](https://ascribed-dev.com/docs/checks/report.md). The [HTML preview](https://ascribed-dev.com/docs/glossary.md#html-preview), which `ascribe diff --format html` writes for a pull request, is part of [review](https://ascribed-dev.com/docs/glossary.md#review), not this. ## Review Reading a pull request's changes as readers will see the pages, in the page preview, the site preview, or the HTML preview, and commenting there. See [Review](https://ascribed-dev.com/docs/review.md). A diagnostic whose next step is `review` may be fine as it is: see [What to do next](https://ascribed-dev.com/docs/checks/diagnostics.md#what-to-do-next). When to check a page again is its [recheck date](https://ascribed-dev.com/docs/glossary.md#recheck-date), not a review. ## Site preview The active page on the project's own dev server, in the browser or the preview panel. It has the published site's look, where `ascribe preview` has the element library's. See [the site preview](https://ascribed-dev.com/docs/editor/preview.md#site-preview). ## Source A folder or repository outside the content, declared in `[sources.]`, that pages take code examples from with `@snippet`. See [`[sources.]`](https://ascribed-dev.com/docs/content-model/sources.md#20-sourcesname) and [`ascribe sources`](https://ascribed-dev.com/docs/examples/sources.md#ascribe-sources). A page's source file, the Markdown it's written in, is the ordinary sense: a source file, as against what a build writes from it. ## Target A dimension value that availability names, such as `self-managed` in `self-managed preview 3.4`; a versioned one has release lines, which `[releases.]` lists. See [Availability specs](https://ascribed-dev.com/docs/writing/directives.md#availability-specs) and [`[releases.]`](https://ascribed-dev.com/docs/content-model/variation.md#121-releasestarget). A link's target, as `ascribe link`, `refs`, and `rename` take it, is what the link leads to, and `ascribe agents sync --target` names an agent whose files it writes. ## Variant Alternative content for a value of a dimension, written with `@variant`. See [`@variant`](https://ascribed-dev.com/docs/writing/directives.md#variant) and [Content that varies](https://ascribed-dev.com/docs/writing/variants.md).