The documentation library holds the
canonical edition of every guidance document that the estate's repositories
share under docs/: the documentation style guide, the scripting standards,
the Rust, Python, front-end, and OpenTofu guides, and the users' guides of the
estate's own libraries. Each canonical edition merges the general improvements
found across the repository copies and omits repository-specific detail.
Refresh a repository's copy by merging the library edition into it, rather than overwriting it outright. Before merging, move repository-specific notes and local links (for example, links to the repository's own migration guides or issues) into a repository-owned document, or carry them across explicitly; do not rely on reviewing the diff to catch them. Improvements that belong to every repository go into the library first; notes that belong to one repository stay in a document that repository owns. A library's users' guide is owned by its upstream repository; the library snapshots it from upstream, so the upstream repository does not refresh its guide from the library.
The OpenTofu guide misspells a variable reference on purpose, in its worked example of an undeclared-variable error. The shared dictionary exempts only that example's exact text, so a repository that carries the guide needs no exemption of its own. Other uses of the misspelt reference that do not contain the complete phrase are reported by the gate.
The shared dictionary also exempts command-line flags and CSS custom properties
that carry the US spelling of "colour", such as --no-color, --color-primary,
--color_primary, --coloring-mode, and --tw-color-red-500. The exemption
stops at the word color, optionally followed by an s, ed, ing, or ize
inflection, and at the next word boundary or underscore. A misspelling in the
words after that point stays visible to the gate. The prefix before the colour
word is open, because custom properties are named freely, so a misspelling in
the prefix of a flag that also contains the colour word is still hidden. A
repository never needs a local exemption for these forms.