A–Z index
1,019 words used in the documentation. 252 have a written page, the others exist through their uses alone.
Filters
C113 words
| Word | Type | First line of the page, or most cited passage | Pages |
|---|---|---|---|
| cached by fingerprint. Transcripts | no definition | “…ocuments: office documents converted to PDF at publication and cached by fingerprint, transcripts read cue by cue with their speakers pseudonymised before anyth…” — Roadmap outline | 3 |
| callout | no definition | “…ge puts the note, the three files stand as tabs; what the meeting produced, a decision written elsewhere, is named in a callout rather than mixed into the text.” — Meeting page | 3 |
| Candidate | Business object | Something the build proposes without asserting it, listed under candidates of the model for a person to settle: a recurring expression without a note, with its score, counts and contexts, which… | 57 |
| Candidate expression | Term | An expression of one to four words that the keyword discovery kept because it recurs without a note: at least three occurrences in two distinct files, neither starting nor ending with a stopword, not… | 22 |
| candidate objects | no definition | “…ewer, an island rendered from a JSON fragment of the contract, loaded on demand. The schemas of the contract become candidate objects, listed on the to-do page.” — Contract import scope review | 4 |
| candidate pairs | no definition | “…s of five words, then to a MinHash signature under a fixed seed; LSH banding enumerates the candidate pairs, so that the full matrix of a corpus is never built.” — Twin resources review | 3 |
| Canonical model | API | dist/model.json, the single file that describes the whole model: every later step reads it and none re-reads the sources. It is described by model.schema.json, published with the core package, and… | 35 |
| caption | no definition | “…scripts of its islands, captioned "server HTML only". Each board carries its caption and a link to its screen note here; each state its caption, its width, who …” — Gallery index | 3 |
| captioned | no definition | “…nversion produced or the preview committed next to it, a rail of its slides captioned by their first line and the extracted text of every slide; a mention read …” — Deck | 3 |
| card | no definition | “"Browse — N categories, as filed in the repository" lists one card per top-level folder of the repository, by name: the folder by the title sources[].folders gi…” — Space | 7 |
| cascade layers | no definition | “Layers: the stylesheet of the project is loaded last, in the fourth cascade layer, so that nothing in the default theme can outrank it.” — Theme override model | 5 |
| cascade layers: tokens | no definition | “… small bundle per island: search, mentions panel, mode switch. Four cascade layers: tokens, base, components, project. The project stylesheet is loaded last a…” — Theme override model | 4 |
| cascade layers: tokens, base | no definition | “…all bundle per island: search, mentions panel, mode switch. Four cascade layers: tokens, base, components, project. The project stylesheet is loaded last and …” — Theme override model | 4 |
| casts | no definition | “… the rules and the grounds carry the hierarchy on their own, and no shadow is cast, where the light scheme casts a soft one under what floats over the page, the…” — Colour scheme | 2 |
| catalogue | no definition | “Every label of the generated site goes through a message catalogue per locale in ICU MessageFormat, plurals, selections, numbers and dates expressed in the mess…” — ICU message catalogues | 10 |
| catalogue per locale | no definition | “…ct is the language of the interface, whose labels come from a message catalogue per locale, and the default locale of every source. A tag with no pack is a buil…” — Locale | 3 |
| Category | Term | A folder of a space as the site lists it: every folder of a repository, at any depth, gets the list of the notes filed under it, at the address a note of that path would take (<source>/<folder>/,… | 31 |
| Category | Screen | The list of one category of a space: a folder of the repository at any depth, or a year or a month of a space whose every note is dated, where a card of the space page, a folder of the tree or a step… | 50 |
| centre | no definition | “…a note, laid out as a wiki a corporate reader already knows: the text in the centre, what the tool computed in the right panel. One template serves every type; …” — Entity page | 6 |
| centre, the breadcrumb | no definition | “…n OpenAPI document, whatever folder their notes are filed in. In the centre, the breadcrumb, the title and the line naming the type, when the note last changed …” — API page | 3 |
| chain | no definition | “The chain of steps concordance build runs in a fixed order, each a pure function of the outputs of the previous ones: configuration, ingestion, parsing, reading…” — Pipeline | 4 |
| changeset | no definition | “Every pull request that changes a published package carries a changeset: the packages it touches, the bump and one sentence for the changelog; the pipeline refu…” — Release | 2 |
| character prefix | no definition | “…he whole corpus without a server: an entity table and one shard per two-character prefix, holding the words of every entity, its title, aliases, summary, note t…” — Search index | 3 |
| characters | no definition | “… of every page. Press / anywhere to reach it, Escape to leave it. From two characters on, the best eight results appear under the field, each with its title and…” — Search | 13 |
| Check | Term | A pure function that reads the model and returns findings. Checks live in one registry shared by the build and the linter, so both report the same thing on the same repository. Each check has an… | 67 |
| Check family | Term | The grouping of the checks in their documentation: every check page states its family, and the list of the checks is laid out by family, source checks, link checks, identifier and type checks,… | 52 |
| check identifier | no definition | “… and the list of the checks is laid out by family, source checks, link checks, identifier and type checks, document checks, vocabulary and filing checks, contra…” — Check family | 4 |
| check the linter | no definition | “A check the linter computes on one repository alone, without the network and without the rest of the model: encoding, frontmatter, identifiers and internal link…” — Local check | 3 |
| check, source | no definition | “…erity and per check, the contracts imported) and every finding, sorted by check, source, path, line and message. Its findings array is the same as the one embed…” — Build log | 4 |
| checkbox | no definition | “…the page, on the surface colour and ruled on its right, holds the facets as checkbox groups with the count of every value: "Page type" and "Space" (the type and…” — Search | 3 |
| checker | no definition | “… order and a clickable equivalent to every keyboard shortcut, and the static checker with the contrast measure run by the gallery command over every state of th…” — Accessibility audit | 3 |
| checkout | no definition | “… source is cloned with its whole history and without the blobs, so that the checkout fetches only the files it reads; record for each file the last commit that …” — Build pipeline | 3 |
| checks in the merge | no definition | “Quality: a linter where the notes are written, the same checks in the merge request and in the build, a SARIF log in the margin of the diff; the wiki keeps pace…” — Roadmap outline | 3 |
| checksums | no definition | “…, packs every published package, verifies the licence inventory, writes the checksums and creates the release from the tag with the changelog entries of the ver…” — Release | 2 |
| chip | no definition | “…I page or a document page carries, after the title, a "Pin" button drawn as a chip with a pin: pressing it pins the page at the end of the row, and the button, …” — Pinned pages | 9 |
| chrome | no definition | “…n the to-do page, the two panels framed under a heading of their own and the chrome in its other shapes (a right-to-left locale, a header with a logo, a footer …” — Gallery index | 3 |
| cited | no definition | “… word used anywhere in the documentation has a page, defined or not. The most cited pages stand next to it as shortcuts. Then the spaces, the sources the site i…” — Home | 16 |
| cites | no definition | “An API declares a consumer that never cites it, or a note cites an API that does not list it. One of the two is out of date. A declared consumer is an identifie…” — Consumer mismatch | 22 |
| citing | no definition | “One place where another file cites an entity: the citing file, the line, the words around the citation and a link to the passage. A mention is either a link an …” — Mention | 8 |
| classic | no definition | “The index is a set of classic scripts under search/, the one kind of resource every browser loads from a file:// page as from a server: an entity table and one …” — Purpose-built contract viewer | 4 |
| classic script | no definition | “The index is a set of classic scripts under search/, the one kind of resource every browser loads from a file:// page as from a server: an entity table and one …” — Purpose-built contract viewer | 4 |
| cloned | no definition | “…ote templates, validate-config confirms the file is valid before anything is cloned. The configuration repository holds the configuration, the theme and the sto…” — Onboarding a repository | 4 |
| Co-occurrence | Term | Two entities named in the same paragraph, counted once per paragraph however many times each is mentioned there. Every pair gives one undirected related link at the cooccurrence confidence of 0.40,… | 3 |
| collation | no definition | “… a folder holding pack.yaml (the name of the language, its apostrophes, its collation options, its plural suffix rules, validated by the language pack schema) a…” — Adding a language pack | 6 |
| collation of its indexes | no definition | “… Each source selects its pack through its BCP 47 locale, which decides its comparison form, its stopwords, its word segmentation and the collation of its index.” — Language pack | 3 |
| collation options | no definition | “…older holding pack.yaml (the name of the language, its apostrophes, its collation options, its plural suffix rules, validated by the language pack schema) and s…” — Adding a language pack | 3 |
| collation options, its plural | no definition | “…holding pack.yaml (the name of the language, its apostrophes, its collation options, its plural suffix rules, validated by language-pack.schema.json) and stopwo…” — Language pack | 3 |
| colour | no definition | “…ess.warn_after_days (180 days without the key), shows its date in the accent colour, doubled by its value in days ("193 days ago"): the only place where a colou…” — Spaces | 16 |
| Colour scheme | Term | One of the two palettes of a theme, light or dark, in force on a page of the site. The dark palette is a second palette, measured on its own, never an inversion of the light one: its contrasts are… | 36 |
| Colour scheme | Screen | The switch of the bar of every page that takes the site from its light palette to its dark one and back. The dark scheme is a second palette, not an inversion of the light one: its colours are… | 56 |
| colours and a label | no definition | “The need: an integrator wants the organisation's name, logo, colours and a label here and there, and never wants to touch the components. theme.yaml already car…” — Theme override model | 3 |
| column | no definition | “… the type, the last change and the space, then the rendered markdown at full column width and the path of the file with its edit link. On the right, three stack…” — Entity page | 11 |
| command | no definition | “…e path takes under thirty minutes, and the repository of the tool replays every command of it on each change so that the guide never promises a step that fails.” — Onboarding a repository | 16 |
| commit | no definition | “The first import of a corpus puts every file in one commit. If the commit alone grouped files, the whole repository would be one document.” — Twin resources review | 19 |
| committed | no definition | “…document, produced by the conversion at build and cached by fingerprint, or committed next to the original by its author; either way the page of the document op…” — Preview | 4 |
| comparison | no definition | “Similar text is the expensive part. Comparing every pair of a corpus of a thousand files is half a million comparisons.” — Twin resources review | 13 |
| Comparison form | Term | The shape in which two texts are compared: lower-cased, accents stripped, apostrophes unified, each word singularised by the suffix rules of the language pack. "Keyword Page", "keyword pages" and… | 17 |
| complete | no definition | “…e first column of the footer, what the tool knows of the site, is exact and complete on its own. The distinction is the point: a publication date or a licence i…” — Legal declaration | 3 |
| component | no definition | “…olours and a label here and there. An integrator never wants to touch the components. Nothing a reader sees names the tool unless the project asks for it. Th…” — Theme override model | 25 |
| component keeps the view | no definition | “…contract between the generator and a theme. A theme that replaces a component keeps the view model; the accessibility checks run on the rendered pages whatever …” — Theme override model | 3 |
| components, project | no definition | “…arch, mentions panel, mode switch. Four cascade layers: tokens, base, components, project. The project stylesheet is loaded last and wins by construction. Th…” — Theme override model | 4 |
| components, project. The project | no definition | “…entions panel, mode switch. Four cascade layers: tokens, base, components, project. The project stylesheet is loaded last and wins by construction. Theme ove…” — Theme override model | 3 |
| concepts | no definition | “…resources into one page with a tab per file. A meeting brings passages, not concepts: it enters the model through the pages it mentions and through the decision…” — Meeting | 3 |
| Confidence | Term | A value between 0 and 1 that expresses how reliable the method that produced a link is. A written link scores 1.00, a frontmatter reference 0.90, a mention in a mapped section 0.70, an occurrence… | 17 |
| Confidence and provenance on every link | Decision | Every link carries a confidence between 0 and 1 and at least one provenance. When methods agree, confidences combine and every provenance is kept. The first version stores the score, orders mentions… | 0 |
| confident | no definition | “…e's type, keyword pages among them, come after, and within a group the most confident neighbour leads. The truncation to six happens after this ordering, so the…” — Entity page | 2 |
| configurable | no definition | “…-CROSS-SOURCE). The model is fetched once and kept in a local cache for a configurable number of hours; when it cannot be read, the linter says so and falls bac…” — Global check | 3 |
| Configuration | Term | The file concordance.yaml of the configuration repository, validated by the published configuration schema and read first by every command: its version, the project, the profile, the plugins, the… | 38 |
| Configuration repository | Term | The repository that holds the configuration, the profile override, the theme, the stopword files, the lock and the pipeline that builds the site and publishes it, and no content: the notes stay in… | 18 |
| console | no definition | “…shown by a viewer the tool builds itself, rather than by the interactive API console the specification first named for OpenAPI contracts. That console weighs mo…” — Purpose-built contract viewer | 3 |
| consumer | no definition | “An API declares a consumer that never cites it, or a note cites an API that does not list it. One of the two is out of date. A declared consumer is an identifie…” — Consumer mismatch | 4 |
| Consumer mismatch | Business rule | An API declares a consumer that never cites it, or a note cites an API that does not list it. One of the two is out of date. A declared consumer is an identifier, written in full or relative to the… | 17 |
| container | no definition | “…ishes: the npm packages under one shared version number and the preset, the container image tagged with the version and latest, a git tag v<major>.<minor>.<patc…” — Release | 7 |
| container image | no definition | “…es: the npm packages under one shared version number and the preset, the container image tagged with the version and latest, a git tag v<major>.<minor>.<patch> …” — Release | 4 |
| contains | no definition | “…ocale carries every key. Messages are resolved at build: the published HTML contains final strings and no localisation library runs in the browser; dates and nu…” — ICU message catalogues | 3 |
| content | no definition | “…tract between the generator and a theme; the published HTML carries the full content of every page. Only interactive components are hydrated: an island is serve…” — Slots, islands and layers | 29 |
| content anomaly | no definition | “… identifier, a severity, a file and line, a message and a remediation. A content anomaly becomes a finding, never a crash. The build fails only when the configu…” — Finding | 4 |
| content signal | no definition | “…by more than half, the pair is an inclusion rather than a duplicate, its content signal is capped and the finding says so. The base name and the title do the re…” — Twin resources review | 3 |
| content signal is capped | no definition | “…more than half, the pair is an inclusion rather than a duplicate, its content signal is capped and the finding says so. The base name and the title do the rest.” — Twin resources review | 3 |
| content stays reachable | no definition | “…ped view models, islands for the interactive parts only, and cascade layers so that the project stylesheet wins. Without javascript the content stays reachable.” — Theme override model | 3 |
| Contract | Term | The machine-readable description of an API that a note declares in its contract attribute, as a URL or a path: an OpenAPI 3 document or a WSDL. The build imports it through a plugin, produces one… | 11 |
| contract an API | no definition | “Contracts: an API note declares its contract, the build imports the operations, each operation note absorbs the operation it names, and a purpose-built viewer r…” — Roadmap outline | 3 |
| contract an API note | no definition | “Contracts: an API note declares its contract, the build imports the operations, each operation note absorbs the operation it names, and a purpose-built viewer r…” — Roadmap outline | 3 |
| Contract checks | Term | The check family of the APIs and their contracts: W-CONTRACT-UNREACHABLE, a contract the contract import could not fetch, read or parse; W-OPERATION-AMBIGUOUS, two operation notes claiming one… | 8 |
| Contract import scope review | Meeting | Working session on what the contract import reads and what it leaves to the notes. Three participants: the maintainer, an author of the specifications and the integrator of the wiki. The transcript… | 0 |
| contract of the model | no definition | “…and the links it is an end of, as the entity page shows them. Declared by the OpenAPI contract of the model query API; nothing of it exists in the command line.” — Get an entity | 3 |
| contract the build imported | no definition | “The page of an interface whose contract the build imported. Same shell as the entity page, laid out at the grain an interface is worked at: its operations. The …” — API page | 3 |
| contract unreachable | no definition | “A contract that cannot be fetched or parsed yields the contract unreachable finding; the note keeps its hand-written operations and the build goes on.” — Contract import scope review | 3 |
| Contract viewer | Screen | The block of the API page of an API whose contract the build imported. It shows the contract next to the note without copying anything into the markdown: what the model knows of the contract stands… | 37 |
| contract; the build imports | no definition | “Contracts: an API note declares its contract, the build imports the operations, each operation note absorbs the operation it names, and a purpose-built viewer r…” — Roadmap outline | 4 |
| CONTRACTS The operations | no definition | “3 · CONTRACTS The operations an API really exposes An API note declares its contract; the build imports the operations. Each operation note absorbs the opera…” — Roadmap outline | 4 |
| contracts imported | no definition | “…ecisions of the lock applied, findings per severity and per check, the contracts imported) and every finding, sorted by check, source, path, line and message. I…” — Build log | 3 |
| contribution address | no definition | “…and "Something to correct? Edit this page" leading there, else to the contribution address project.contribute_url declares, and shown only when it leads somewhe…” — Entity page | 3 |
| Contribution point | Term | One of the ways a plugin adds to the tool, named by a key of its manifest: readers (a reader per file format), converters (a converter), sources (a source of entities such as a contract import),… | 45 |
| Conversion | Term | The transformation of an office document into a PDF at build, by a converter plugin, so that its text is extracted from that PDF and nothing else, and the conversion: block of the configuration that… | 20 |
| Conversion failed | Business rule | An office document could not be converted to PDF: timeout, size, corruption or missing converter. The document stays downloadable, without preview or extracted text. | 49 |
| converted to PDF | no definition | “Documents: office documents converted to PDF at publication and cached by fingerprint, transcripts read cue by cue with their speakers pseudonymised before anyt…” — Roadmap outline | 4 |
| Converter | Term | A contribution point of the plugin API that turns a document into representations the pipeline reads: a PDF today, thumbnails and text later, written under the fingerprint cache and never next to the… | 21 |
| core | no definition | “…mponents/ for a page, an attribute value or a section rendered specially. The core types are modules and the default profile is assembled from them; a project k…” — Type module | 9 |
| core types | no definition | “…nents/ for a page, an attribute value or a section rendered specially. The core types are modules and the default profile is assembled from them; a project keep…” — Type module | 2 |
| Core, plugins, preset | Decision | The core reads markdown and produces JSON and depends on no office format nor system tool. Readers, converters, importers, viewers and heavy projections are plugins declared in the configuration. The… | 0 |
| Corpus | Term | The notes and documents of every source a build reads together: what the dictionary, the search index and the alphabetical index cover, and what a candidate expression recurs across. A golden corpus… | 31 |
| correction | no definition | “…ated at build, fragmented by prefix, loaded in pieces as the reader types, matching by prefix without typo correction, deterministic from one build to the next.” — Purpose-built contract viewer | 4 |
| counter | no definition | “…ng that page; the document viewer opens as soon as its script runs, with its counter, its zoom and its find field over the extracted text, and the strip follows…” — Document page | 3 |
| crash | no definition | “…ne, a message and a remediation. A content anomaly becomes a finding, never a crash. The build fails only when the configuration says so; the linter fails from …” — Finding | 3 |
| credentials | no definition | “…ndexed only when a decision asks for it. The configuration never carries a credential either: a private source gets its token from the git environment of the ma…” — Privacy | 4 |
| credit | no definition | “… a faulty key is reported by its path like a configuration error. The footer credits the tool only when the project asks for it (footer.credit: true, a plain li…” — White label by default | 3 |
| criterion | no definition | “…e text, and the merged and separated pairs, a merged pair grouped under the criterion lock file whatever its score, a separated pair never reported, and the dom…” — Lock | 4 |
| cross | no definition | “… the ink and marked as the current page, every chip a link to its page with a cross that removes it, and the count, "3 pinned", at the end. Moving to another pa…” — Pinned pages | 5 |
| Cross-source link | Business rule | A markdown link leaves its source, with the <source>:<path> prefix or with a relative path that climbs above the source root into a sibling source, while inference.cross_source_links is off. The link… | 26 |
| Cue | Term | One timed unit of a transcript: a start and an end timecode and the words spoken between them. A cue is the position of a word read in a transcript, as a page or a slide is in a converted document: a… | 21 |
| cue by cue | no definition | “…onverted to PDF at publication and cached by fingerprint, transcripts read cue by cue with their speakers pseudonymised before anything else reads them, twin re…” — Roadmap outline | 3 |
| cues of a transcript | no definition | “… PDF the converter produced, or of the PDF given as a source, and the cues of a transcript with their timecodes. An office document never gives its text any oth…” — Extracted text | 3 |
Words without a definition sit in the index like the others, dotted, with the passage that uses them most in place of a definition. That is the working list of a glossary owner.