Rules
39 business rules described. A business rule is a condition the business imposes, with what it constrains and what happens when it is broken.
| Business rule | Severity | First line | Links |
|---|---|---|---|
| Ambiguous relation | info | A link between two entities fell back to the generic relation because no section, no typed attribute and no single allowed relation decided it. It is kept at a capped confidence. The finding is raised by the relation typing step and points at the note the link was read in, on the line of its first located provenance; a link that co-occurrences alone know raises nothing, since a co-occurrence names no file and is unnamed by nature. | 51 |
| Relation typing | info | Every link between two notes ends up with a relation of the profile, decided on four rungs, the first that applies winning: a mapped section (a business object under ## Objects of a screen is accesses), a typed frontmatter attribute (reads is accesses in read mode), a type pair that admits a single relation (a markdown link or a plain mention between a rule and a screen is constrains, marked relation_origin: pair and turned around when the profile only allows it the other way), then related, kept with its confidence capped at 0.60 and reported by the ambiguous relation check. The first two rungs come from what the author wrote and are never overturned; a declared relation the profile does not allow between the two types is dropped by the relation outside the matrix check. The labels shown for a relation, in either direction, come from the profile alone. The architecture guide and the writing guide describe it. | 47 |
| Suggested domain | info | A note no frontmatter, folder or glob files lies within the radius of a pivot of the neighbourhood: a term with a note of its own whose distinct neighbours, over the typed links and the co-occurrence neighbourhood, reach the configured threshold. The note is a candidate for a domain named after the pivot, the last segment of its identifier, and is attached to the closest pivot, at equal distance to the one of highest degree, then to the first identifier in code-unit order. A stopword or a term the lock file rejects never pivots. The build proposes and files nothing: a growing corpus moves its pivots, and a note would swing from one domain to another between two builds. The proposal is promoted by declaring the domain in the configuration with the folders or globs that claim its notes, or by naming the note under domains in the lock file; the configuration may also let the build file every reached note itself, with the origin inferred. | 45 |
| Duplicate candidate | info | Two resources look like forms of the same document, with a reconciliation score between 0.5 and 0.9. They stay separate until a human decides. | 35 |
| Unclassified domain | info | A note sits under no folder a declared domain claims, matches no domain glob and declares none in frontmatter. It lands in the unclassified domain. A domain claims a folder with folder: true, the folder named after its identifier, or folder: <name>, anywhere on the path of a note in any source; a subdomain declared by folder claims only the notes under its parent's folder, or anywhere on a path the parent's globs match when the parent is declared by globs. Folders and globs combine, the deepest domain winning, then the last declared. | 32 |
| Term homonym | info | Two entities share a title or an alias once spellings are compared: same form after lower-casing, accent stripping and singularisation. The recognition dictionary keeps both, every occurrence of the form links to each entity at half the confidence it would have with a single target, glossary entities first, and the finding names the form and the entities. When the two are different things, distinct titles or aliases settle it; when they are one concept seen from two sides, as the glossary term and the business object called "Entity" in this wiki, both stay and a ## Not to be confused with section tells the reader which is which. The linter reports the same finding in global scope for a local title that an entity of another type carries in the published model. A twin folded into its note is no homonym: the twin resources are reconciled before the dictionary is built, and the titles and aliases of the folded twin name the entity it became, once. | 31 |
| Document without markdown | info | A document has no markdown representation once the twin resources are reconciled: it stands as an entity of its own, or merged with other documents only. Its words are recorded from the text extracted from its PDF or its cues, but nobody wrote about it. The to-do page lists these documents; a note next to the document with the same base name, or declaring it under source, merges with it and lifts the finding. | 30 |
| Personal mention detected | info | A personal name was detected in a transcript outside the pseudonymisation dictionary. It is flagged for review before anything is published. | 13 |
| Unused term | info | A glossary term is never cited: neither its title nor its aliases appear elsewhere. | 10 |
9 rules of 9 — pagination by twenty. The Links column counts the related pages, which brings the most central rules of the journey to the top.